SNS Server接口规范

目录

1 CMI12

1.1 getAccess2LuxuryArea 查询图书分类土豪区映射接口

1.2 getBookFanLevelInfo 根据用户的阅读号,图书ID得到图书粉丝等级和粉丝值

1.3 getBookFanLevelInfoList 查询用户图书粉丝等级信息明细接口

1.4 getbookFanLevelRightsList 查询图书粉丝值等级权益映射接口

1.5 getBookFanLevelRuleInfo 获取图书粉丝等级规则

1.6 getFanRanking 粉丝排行榜接口

1.7 getGlobalFanLevelInfo 根据用户的阅读号得到用户全站粉丝值、粉丝等级等级

1.8 getGlobalFanLevelRuleInfo 获取全站粉丝等级规则

1.9 getGlobalFanScoreChangeRecords 全站粉丝值变更明细接口

1.10 promoteGlobalFanLevel 全站粉丝等级升级接口

2 CMI13

2.1 apply4CertifiedAuthor 作家认证申请接口

2.2 apply4Paying 支付申请接口

2.3 authorPayRequest 支付申请接口

2.4 batchUpdateVipLevelScore 会员等级积分批量下发接口

2.5 batchUpdateVipScore 批量下发接口

2.6 buyProps 购买道具接口

2.7 cancelMonthPayment 取消包月产品

2.8 getAccess2LuxuryArea 查询图书分类土豪区映射接口

2.9 getAllPropsInfoList 查询所有道具的基本信息

2.10 getAuthorGradeInfo 作家积分等级信息接口

2.11 getAuthorizationStatus 作家认证状态查询接口

2.12 getLevelWeightInfo 根据阅读号、图书ID、图书分类ID获取权重和等级

2.13 getPrerogativeInfos 查询对应会员等级的特权信息接口

2.14 getPropsBuyTopList 累计道具购买次数排行

2.15 getPropsCanBuyList 用户可购买的道具列表

2.16 getPropsUseTopList 累计道具使用次数排行

2.17 getTieModelList 获取帖子模板信息列表

2.18 getUserMonthTicket 查询用户赠送的月票总数

2.19 getUserPorpsBuyRecordList 根据阅读号查询指定用户购买道具的历史记录信息

2.20 getUserPropsbyId 根据阅读号、道具ID 查询指定用户指定道具基本信息和数量

2.21 getUserPropsList 根据阅读号、道具类型、到期类型查询指定用户拥有的道具基本信息和数量列表

2.22 getUserPropsUseRecordList 根据阅读号查询指定用户的道具使用记录

2.23 getUserVipInfo 询会员等级积分接口

2.24 getVipLevelRules 查询会员等级规则接口

2.25 getVipLevelScoreDeductionDetail 查询会员等级积分扣减明细接口

2.26 getVipPrivileges 会员特权查询接口

2.27 getVipScoreDeductionDetail 查询会员消费积分扣减明细接口

2.28 propsRecommend 道具推荐列表接口

2.29 reduceLevelScore4DelForumPosts 等级积分扣减接口

2.30 unpack 礼包下发接口方法

2.31 updateAuthorizationStatus 作家合同状态变更接口

2.32 useProps 用户使用道具接口

3 CMI14

3.1 addBooksToOneSheet 往单个书单添加多本图书

3.2 addBookToMultipleSheet 单本图书添加到多个书单

3.3 addReviewScoreRecord 给图书评分记录

3.4 batchClickBookSheets 书单点击量批处理接口

3.5 deleteNewSheetDynamic 删除最新动态中的书单接口

3.6 getAuthorRankingList 获取作家排行榜

3.7 getBookSheetInfo 获取书单信息详情接口

3.8 getBookSheetsByUser 获取用户书单列表接口

3.9 getBookSheetsClickTimesRankingList 查询书单点量排行榜

3.10 getBookSheetsGlorifiedTimesRankingList 查询书单点赞排行榜

3.11 getFreePackage 领取免费礼包接口

3.12 getNewDynamicList 查询好友创建书单动态信息接口,改造接口

3.13 getNewSheetDynamicInfo 查询最新书单动态信息接口

3.14 getShareBookSheetsByUser 获取用户分享的书单列表接口

3.15 getSheetRankList 查询书单综合排行榜接口

3.16 getSingleNumAboutBook 查询图书分享次数总和、加入书单总数、被打赏人次总数接口

3.17 getUserVipInfo 查询会员基础信息接口

3.18 glorifyBookSheet 书单点赞接口

3.19 havReviewScoreProxy 判断用户是否有评分权限

3.20 queryUsersDistance 查询周边用户距离信息

3.21 queryVisitedDetail 查询用户被访客访问明细

3.22 queryVisitorData 查询访客访问数据

3.23 recordCreateSheetDynameic 记录创建书单动态接口

3.24 recordNewSheetDynamic 记录最新书单动态接口

3.25 recordVisitorBehaviorData 记录访客行为数据上报

3.26 searchUserByLBS 查询周边好友信息

3.27 uploadLocation 用户上传地理位置信息

4 CMI15

4.1 addBooksToOneSheet 往单个书单添加多本图书

4.2 addBookToMultipleSheet 单本图书添加到多个书单

4.3 addContentReview 内容评论接口

4.4 bookSheetScore 书单评分

4.5 cancelCollectBookSheet 取消收藏

4.6 collectBookSheet 收藏书单

4.7 createBookCatalog 添加书目接口

4.8 createBookSheet 用户创建书单

4.9 getBookSheetCollectByMsisdn 查看用户收藏的书单

4.10 getBookSheetInfo 获取书单信息详情接口

4.11 getBookSheetInfoListByLabelID 根据标签id查询书单信息

4.12 getBookSheetLabelBySheetId 查询书单标签接口

4.13 getBookSheetsByUser 获取用户书单列表接口

4.14 getContentReview 查询内容评论接口

4.15 getContentReviewCount 查询内容评论数量接口

4.16 getContentReviewList 查询内容评论列表接口

4.17 getNewSheetDynamicInfo 查询最新书单动态信息接口

4.18 getSystemLabelByType 查询系统标签接口

4.19 getVipScoreDetail 获取会员积分或者消费明细

4.20 isCollected 查询书单是否被当前用户收藏接口

4.21 modifyBookSheet 用户修改书单

4.22 modifyBookSheetTag 修改书单标签

4.23 queryBookSheetEachScoreNum 查询书单各分值下评分人数

4.24 updateBookSheetLabelByLabelID 更新书单标签

5 CMI16

5.1 createBookSheet 创建书单接口

5.2 getFanHundredRanking 根据bookid查询图书粉丝值前100

5.3 modifyBookSheet 修改书单

6 oscache

6.1 getAllLayerTemplateNodeList 根据节点ID查询布局模板页面列表接口

6.2 getAllPtlPageList 分页查询所有页面列表接口

6.3 getCircleLabelContentList 查询轮循标签内容列表接口

6.4 getPageCircleLabelById 根据页面标签ID查询轮循标签内容接口

6.5 getPageCircleLabelList 分页查询所有有效的轮循标签内容接口

6.6 getPtlPageByFileName 根据文件名查询页面信息接口

6.7 getSnsParameter 获取门户参数接口

6.8 getSystemSetting 分页查询所有系统参数接口

6.9 getUserAreaByMobile 获取手机号码段区域接口

7 书评人等级体系

7.1 getBookClassRank 获取书评分类排行榜列表

7.2 getBookReviewRank 获取书评图书排行榜列表

7.3 getBookReviewInfoByMsisdn 根据用户的阅读号得到用户用户的书评人的得分和等级

7.4 getBookReviewLevelMap 获取书评人等级信息列表接口

7.5 getBookReviewRank 获取书评图书排行榜列表

7.6 getBookSheetShareRankByBookId 查询单本图书书单分享排行榜

7.7 getSalaryRequest 书评人等级工资领取

7.8 UpdateBookReviewerScore 顶驳书评分增减接口

8 互帮互助

8.1 addtionHelpQuetion 追加提问接口

8.2 getHelpBigTypeList 获取互帮互助官方解答大类型分类列表接口

8.3 getHelpLabelList 查询问题分类接口

8.4 getHelpOfficialAnswerInfo 获取官方解答答案详情接口

8.5 getHelpOfficialQuestionInfo 查询官方解答问题详情接口

8.6 getHelpSmallTypeList 获取官方解答小类型列表接口

8.7 isMyQuestionById 是否是我的提问接口

9 其他

9.1 getBlockReserveInfo 查询模块定制信息接口

9.2 setBlockReserveInfo 设置模块定制信息接口

10 废弃

10.1 addUserMember 添加会员信息接口

10.2 addUserMemberExt 添加扩展用户信息接口

10.3 batchValidateVIP 批量查询用户是否是悦大使接口

10.4 countMBlogList 获取我的/他的日志数量接口

10.5 getAllLiveMessage 获取直播间留言接口

10.6 getBlogsCountByBook 获取提到书的日志总数接口

10.7 getLiveTopicMessage 获取直播间留言接口

10.8 getUserBlogsByBook 查询用户提到书的日志列表接口

10.9 getUserComments 查询指定用户的评论列表接口

10.10 isBookCoupons 是否可以生成书券

10.11 upadateMblogWeiboid 更新日志同步到新浪的新浪ID接口

10.12 updateUserMemberById 更新会员信息接口

10.13 updateUserMemberExtById 修改用户扩展信息接口

11 微博

11.1 addCommentTesk 当新增抓取日志评论任务接口

11.2 applyStarAuthor 申请悦大使接口

11.3 auditChange 日志或评论批量审核接口

11.4 delCommentTesk 删除悦大使抓取日志评论任务接口

11.5 deleteMblog 删除日志

11.6 getAllSTARAuthorInLabel 获取悦名家轮播标签配置接口

11.7 getBookReadTimes 获取图书阅读用户数

11.8 getCelebrityLabelInfo 获取悦读大使分类信息接口

11.9 getCelebrityLabelList 获取悦读大使分类列表接口

11.10 getCelebrityListByLabel 获取悦读大使分类下的悦大使列表接口

11.11 getCMIdByMsisdn 查询悦大使的营销参数接口

11.12 getCommentById 根据评论id获取评论信息接口

11.13 getFamousPersonGrade 查询悦大使职业等级接口

11.14 getFamousPersonInfoById 根据手机号(虚拟手机号)获取悦大使的认证信息接口

11.15 getFamousPersonInfoList 获取所有已认证的悦大使信息列表接口

11.16 getHotMBlogList 获取热门微薄列表接口

11.17 getMBlogCommentList 获取日志评论列表接口

11.18 getMBlogInfo 获取日志详情接口

11.19 getMBlogList 获取日志列表接口

11.20 getMBLogListByLabel 获取悦读大使分类下的日志列表接口

11.21 getMBLogListByLeader 获取名家领读日志列表接口

11.22 getMoreMBlogList 获取更多日志列表接口

11.23 getNewComment 获取最新评论列表接口

11.24 getNewMBlogList 获取最新微薄列表接口

11.25 getRefBookMBlogList 获取提到书日志列表接口

11.26 getThirdAccountForOther 其他平台通过虚拟手机号获取第三方账号信息接口

11.27 getThirdAccountInfoByNickName 通过昵称获取第三方账号信息接口

11.28 getThirdAccountInfoByXMsisdn 通过虚拟手机号获取第三方账号信息接口

11.29 getTopComment 获取精彩评论列表接口

11.30 getTopMBlogListByLabel 获取悦读大使分类下的置顶日志列表接口

11.31 qryReceiveComment 查询收到评论接口

11.32 qryRevSendCommentCount 收到和发出评论数接口

11.33 qrySendComment 查询发出评论接口

11.34 releaseMBlog 发表日志接口

11.35 saveOrUpdateWeiboUserInfo 更新/保存第三方账号信息接口

11.36 toCommentMBlog 评论日志接口

11.37 transmitMBlog 转发日志接口

11.38 unionFriendsAndFans 合并好友圈接口

11.39 verifyAccount 获取第三方用户信息接口

12 成长体系

12.1 doUserTask 任务处理接口

12.2 getUserTask 任务领取接口

12.3 getUserTaskInfo 任务详细信息查询接口

12.4 getUserTaskInfoByMsisdnAndId 指定任务状态查询接口

12.5 getUserTaskList 任务列表查询接口

13 排行榜

13.1 getBooksShareRankList 获取图书分享排行列表接口

13.2 getPersonsShareRankList 获取分享达人排行列表接口

13.3 getStarAuthorHotBookRank 获取悦读热书榜接口

13.4 getStarAuthorScoreRank 获取悦大使职业积分排行榜接口

13.5 getStarAuthorShareBookRank 获取悦读分享榜接口

13.6 getSubjectRankList 查询主题分享排行列表

14 晒书单

14.1 createBookCatalog 添加书目接口

14.2 createBookSheet 创建书单接口

14.3 deleteBookCatalog 删除书目接口

14.4 deleteBookSheet 删除书单接口

14.5 deleteShareBookSheet 删除分享书单接口

14.6 getBookCatalogsByUser 获取用户某书单下书目列表接口

14.7 getBookSheetInfo 获取书单信息详情接口

14.8 getBookSheetsByUser 获取用户书单列表接口

14.9 getShareBookSheetsByUser 获取用户分享的书单列表接口

14.10 modifyBookSheet 修改书单接口

14.11 setBookCatalogPermission 书目隐私设置接口

14.12 setBookSheetPermission 书单隐私设置接口

14.13 shareBookSheet 分享书单接口

15 用户同步

15.1 getUserMemberByName 根据用户名查询会员信息接口

15.2 getUserMemberExtByMemberId 通过用户信息Id查询用户扩展信息接口

16 直播间

16.1 addLiveMsg 新增用户直播间留言接口

16.2 addReserve 一键预定直播接口

16.3 cancelReserve 一键取消预定直播接口

16.4 getAllLiveMsg 查询直播间留言接口

16.5 getAllLiveSpeakMsg 查看主持人和嘉宾直播聊天记录接口

16.6 getLiveMessageByMessageId 获取直播间留言详情

16.7 getLiveRoomInfo 获取直播间信息

16.8 getLiveSpeakContent 查询直播间主持人或嘉宾的留言内容接口

16.9 getLiveToastmaster 查询主持人信息列表接口

16.10 getLiveToastmasterRoom 查询嘉宾或主持人参与的直播间接口

16.11 getLiveTopicInfoByTopicId 获取直播间话题详情接口

16.12 getLiveTopicListByRoomId 通过直播间ID获取此直播间所属话题列表信息接口

16.13 getMyLiveMessage 查询我的直播间留言接口

16.14 getReserveRoom 获取需要预订的直播间列表接口

16.15 getRoomOnlineSum 获取直播间在线人数接口

16.16 hasReserve 判断该用户是否已经一键预订直播间接口

16.17 hasReserveAgain 判断是否已经通过一键预订功能预订了此直播间接口

16.18 predictLiveRoom 预订直播间接口

16.19 refreshOnlineUser 更新直播间在线用户接口

16.20 roomOnlineUserManager 直播间用户管理接口

16.21 searchLiveRoom 查询直播间信息接口

17 积分经验值等级

17.1 deductIntegral 扣除积分接口

17.2 exchangeTicket 积分兑换接口

17.3 getConsumeScore 获取用户积分

17.4 getIntegralChangeList 查询积分兑换列表

17.5 getPrerogativeInfos 根据用户手机号获取该用户所具有的特权信息

17.6 getProfessionConsumeScore 获取用户职业积分

17.7 getUserGrade 查询用户级别

17.8 getUserIntegExperGradeInfo 查询用户积分经验值等级

17.9 getUserMonthTicket 根据用户号码和身份查询免费月票

17.10 qryScore 查询用户积分经验值

17.11 qryScoreLevelRule 经验值等级规则查询

17.12 updateIntegralByMobile 兑换书券扣除积分接口

18 空间

18.1 addBlackUser 添加黑名单接口

18.2 addShareInfoList 批量添加分享信息接口

18.3 addUserAttention 添加关注接口

18.4 cancelUserAttention 取消关注接口

18.5 delAllShare 删除全部分享信息接口

18.6 delShareInfoList 批量删除分享表信息接口

18.7 generateMedal 下发勋章接口

18.8 getAttendsOrFansPageList 获取关注/粉丝分页列表接口

18.9 getAuthorList 获取偶像信息列表接口

18.10 getBatchShareInfo 通过id列表批量获取分享信息接口

18.11 getBlackUserList 获取黑名单用户列表接口

18.12 getBlogInfoListBySubjectId 悦·分享 获取与主题相关的微博信息列表接口

18.13 getCatalogInfoList 根据主题Id获取图书专区列表接口

18.14 getClassList 获取偏好信息列表接口

18.15 getIllegalWordList 查询敏感词列表接口

18.16 getMedalInfo 获取勋章信息接口

18.17 getMsgFriendPageList 查询站内信好友分页列表接口

18.18 getNewDynamicList 通过类型和所有者手机号获取他关注的那类最新动态接口

18.19 getShareInfoList 根据手机号码获取分享信息列表接口

18.20 getShareToOutSiteCommentList 获取同步到外站言论接口

18.21 getSNSInfo 查询关注和粉丝数量接口

18.22 getSubjectInfoBySubjectId 根据主题Id获取主题信息接口

18.23 getUserMedalIdList 获取用户勋章Id列表接口

18.24 getUserStatus 用户互动信息查询接口

18.25 isBlackUser 判断用户是否是黑名单用户接口

18.26 IsExitsAttend 判断是否已经关注用户接口

18.27 isShared 判断图书是否被分享过接口

18.28 removeBlackUser 解除黑名单接口

18.29 searchAttendOrFanUser 查询关注/粉丝接口

18.30 shareChangeNotify 分享审核通知接口

18.31 updateNicknameComment 修改好友昵称备注接口

18.32 updateShareInfo 更新分享原因接口

18.33 userCheckIn 用户报到接口

19 论坛

19.1 getLinkCircleUrl 查询轮循链接url列表接口

20 通知

21 CMI19

22 CMI21

23 CMI23

20.1 userChange 用户变更

24 错误码表


返回目录

1 CMI12

1.1 getAccess2LuxuryArea 查询图书分类土豪区映射接口

1.1.1 接口描述

查询图书分类土豪区映射接口

1.1.2 最后修改信息

1.1.3 调用方

1.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

luxuryAreaInfoList

Response

List

0...1

图书分类土豪区映射列表

LuxuryAreaInfo

luxuryAreaInfoList

LuxuryAreaInfo

0...N

图书信息

classId

LuxuryAreaInfo

String

0...1

图书分类ID

className

LuxuryAreaInfo

String

0...1

分类名称

isPublish

LuxuryAreaInfo

int

0...1

是否出版

type

LuxuryAreaInfo

int

0...1

分区类型

ralation

LuxuryAreaInfo

int

0...1

是否属于土豪区

1.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.1.6 报文样例

请求方法

 
POST /portalapi/getAccess2LuxuryArea

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <luxuryAreaInfoList>
        <LuxuryAreaInfo>
            <classId>30</classId>
            <className>玄幻</className>
            <isPublish>0</isPublish>
            <type>1</type>
            <ralation>1</ralation>
        </LuxuryAreaInfo>
    </luxuryAreaInfoList>
</Response>
 

1.1.7 接口响应码

响应码

描述

200

成功

8040

返回数据为空

2000

程序异常

1.2 getBookFanLevelInfo 根据用户的阅读号,图书ID得到图书粉丝等级和粉丝值

1.2.1 接口描述

根据用户的阅读号,图书ID得到图书粉丝等级和粉丝值

1.2.2 最后修改信息

1.2.3 调用方

1.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookID

Request

String

1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

bookFanLevel

Response

String

1

图书粉丝等级

bookFanScore

Response

String

1

图书粉丝值

1.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.2.6 报文样例

请求方法

 
POST /portalapi/getBookFanLevelInfo

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <bookID>1</bookID>
</Request>
 

响应报文

  
<Response>
    <bookFanLevel>1</bookFanLevel>
    <bookFanScore>500</bookFanScore>
</Response>
 

1.2.7 接口响应码

响应码

描述

8000

阅读号为空

8001

阅读号非法

8002

图书ID为空

8003

图书ID非法

2000

其它异常

1.3 getBookFanLevelInfoList 查询用户图书粉丝等级信息明细接口

1.3.1 接口描述

查询用户图书粉丝等级信息明细

1.3.2 最后修改信息

1.3.3 调用方

1.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

bookFanLevelInfoList

Response

List

0...1

图书粉丝等级信息列表

bookFanLevelInfo

bookFanLevelInfoList

BookFanLevelInfo

0...N

全站粉丝值变更信息

bookID

bookFanLevelInfo

String

1

图书id

bookFanLevel

bookFanLevelInfo

String

1

图书粉丝等级

bookFanScore

bookFanLevelInfo

String

1

粉丝值

1.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.3.6 报文样例

请求方法

 
POST /portalapi/getBookFanLevelInfoList

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>5</total>
    <bookFanLevelInfoList>
        <bookFanLevelInfo>
            <bookID>1</bookID>
            <bookFanLevel>1</bookFanLevel>
            <bookFanScore>100</bookFanScore>
        </bookFanLevelInfo>
    </bookFanLevelInfoList>
</Response>
 

1.3.7 接口响应码

响应码

描述

8000

阅读号为空

8001

阅读号非法

4003

start为空

4004

start非法

4005

count为空

4006

count非法

2000

other

1.4 getbookFanLevelRightsList 查询图书粉丝值等级权益映射接口

1.4.1 接口描述

查询图书粉丝值等级权益映射接口

1.4.2 最后修改信息

1.4.3 调用方

1.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

bookFanLevelRightInfoList

Response

List

0...1

图书粉丝等级权益信息列表

bookFanLevelRightInfo

bookFanLevelRightInfoList

BookFanLevelRightInfo

0...N

图书粉丝等级权益信息

levelId

bookFanLevelRightInfo

int

0...1

等级ID

levelName

bookFanLevelRightInfo

String

0...1

等级名称

bookFanRightInfoList

bookFanLevelRightInfo

List

0...1

权益信息列表

bookFanRightInfo

bookFanRightInfoList

BookFanRightInfo

0...N

权益信息

rightId

bookFanRightInfo

String

0...1

权益ID

rightName

bookFanRightInfo

String

0...1

权益名称

rightsDesc

bookFanRightInfo

String

0...1

权益描述

1.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.4.6 报文样例

请求方法

 
POST /portalapi/getbookFanLevelRightsList

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <bookFanLevelRightInfoList>
        <bookFanLevelRightInfo>
            <levelId>3</levelId>
            <levelName>会员</levelName>
            <bookFanRightInfoList>
                <bookFanRightInfo>
                    <rightId>1</rightId>
                    <rightName>土豪区讨论</rightName>
                    <rightsDesc>土豪区讨论</rightsDesc>
                </bookFanRightInfo>
            </bookFanRightInfoList>
        </bookFanLevelRightInfo>
    </bookFanLevelRightInfoList>
</Response>
 

1.4.7 接口响应码

响应码

描述

200

成功

8041

返回数据为空

2000

程序异常

1.5 getBookFanLevelRuleInfo 获取图书粉丝等级规则

1.5.1 接口描述

获取图书粉丝等级规则

1.5.2 最后修改信息

1.5.3 调用方

1.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

bookFanLevelRuleList

Response

bookFanLevelRule

bookFanLevelRuleList

id

bookFanLevelRule

String

1

等级ID

name

bookFanLevelRule

String

1

等级名称

upperScore

bookFanLevelRule

String

1

上限粉丝值

lowerScore

bookFanLevelRule

String

1

下限粉丝值

rightList

bookFanLevelRule

权益列表

right

rightList

权益

rightId

right

String

1

权益等级ID

rightName

right

String

1

权益等级名称

rightsDesc

right

String

1

权益等级描述

validTime

right

String

1

有效时间

quantity

right

String

1

数量

type

right

String

1

权益类型

1.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.5.6 报文样例

请求方法

 
POST /portalapi/getBookFanLevelRuleInfo

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <bookFanLevelRuleList>
        <bookFanLevelRule>
            <id>1</id>
            <name>name</name>
            <upperScore>1000</upperScore>
            <lowerScore>700</lowerScore>
            <rightList>
                <right>
                    <rightId>1</rightId>
                    <rightName>name</rightName>
                    <rightsDesc>desc</rightsDesc>
                    <validTime>20140101</validTime>
                    <quantity>1</quantity>
                    <type>1</type>
                </right>
            </rightList>
        </bookFanLevelRule>
    </bookFanLevelRuleList>
</Response>
 

1.5.7 接口响应码

响应码

描述

8801

图书粉丝等级规则为空

2000

其它异常

1.6 getFanRanking 粉丝排行榜接口

1.6.1 接口描述

查询粉丝排行榜

1.6.2 最后修改信息

1.6.3 调用方

1.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

0...1

阅读号

rankingType

Request

String

1

排行榜类型

bookId

Request

String

0...1

图书号

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

msisdn

Response

String

1

阅读号

bookId

Response

String

1

图书号

FanRankingList

Response

List

0...1

粉丝排行榜信息列表

FanRankingInfo

FanRankingList

FanRankingInfo

0...N

粉丝排行榜信息

bookID

FanRankingInfo

0...1

图书id

msisdn

FanRankingInfo

String

1

阅读号

fansScore

FanRankingInfo

String

1

粉丝值

1.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.6.6 报文样例

请求方法

 
POST /portalapi/getFanRanking

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <rankingType>0</rankingType>
    <bookId>123456</bookId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>5</total>
    <msisdn>18700000000</msisdn>
    <bookId>123456</bookId>
    <FanRankingList>
        <FanRankingInfo>
            <bookID>1</bookID>
            <msisdn>18700000000</msisdn>
            <fansScore>18700000000</fansScore>
        </FanRankingInfo>
    </FanRankingList>
</Response>
 

1.6.7 接口响应码

响应码

描述

8001

阅读号非法

4003

start为空

4004

start非法

4005

count为空

4006

count非法

8113

排行榜类型非法

2000

other

1.7 getGlobalFanLevelInfo 根据用户的阅读号得到用户全站粉丝值、粉丝等级等级

1.7.1 接口描述

根据阅读号,查询用户的全站粉丝值、粉丝等级等级和剩余粉丝值

1.7.2 最后修改信息

1.7.3 调用方

1.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Response

String

1

阅读号

fanlevel

Response

String

1

全站粉丝等级

fansScore

Response

String

1

全站粉丝值

remainingScore

Response

String

1

剩余粉丝值

1.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.7.6 报文样例

请求方法

 
POST /portalapi/getGlobalFanLevelInfo

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <msisdn>18600000000</msisdn>
    <fanlevel>0</fanlevel>
    <fansScore>500</fansScore>
    <remainingScore>500</remainingScore>
</Response>
 

1.7.7 接口响应码

响应码

描述

8000

阅读号为空

8001

阅读号非法

2000

其它异常

1.8 getGlobalFanLevelRuleInfo 获取全站粉丝等级规则

1.8.1 接口描述

获取全站粉丝等级规则

1.8.2 最后修改信息

1.8.3 调用方

1.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

globalFanLevelRuleList

Response

globalFanLevelRule

globalFanLevelRuleList

id

globalFanLevelRule

int

1

等级ID

levelName

globalFanLevelRule

String

1

等级名称

fansScore

globalFanLevelRule

String

1

升级消耗粉丝值

rightList

globalFanLevelRule

权益列表暂时为空

right

rightList

1.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.8.6 报文样例

请求方法

 
POST /portalapi/getGlobalFanLevelRuleInfo

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <globalFanLevelRuleList>
        <globalFanLevelRule>
            <id>1 </id>
            <levelName>name</levelName>
            <fansScore>700</fansScore>
            <rightList>
                <right></right>
            </rightList>
        </globalFanLevelRule>
    </globalFanLevelRuleList>
</Response>
 

1.8.7 接口响应码

响应码

描述

8010

全站粉丝等级规则为空

2000

其它异常

1.9 getGlobalFanScoreChangeRecords 全站粉丝值变更明细接口

1.9.1 接口描述

查询全站粉丝值变更明细

1.9.2 最后修改信息

1.9.3 调用方

1.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

int

1

起始位置

count

Request

int

1

条数

changeType

Request

int

1

变更类型

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

changeRecords

Response

List

0...1

全站粉丝值变更明细列表

globalFanScoreChangeInfo

changeRecords

GlobalFanScoreChangeInfo

0...N

全站粉丝值变更信息

changedScore

globalFanScoreChangeInfo

long

0...1

粉丝值变更值

changeTime

globalFanScoreChangeInfo

long

0...1

粉丝值变更时间

1.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.9.6 报文样例

请求方法

 
POST /portalapi/getGlobalFanScoreChangeRecords

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <start>1</start>
    <count>2</count>
    <changeType>0</changeType>
</Request>
 

响应报文

  
<Response>
    <total>10</total>
    <changeRecords>
        <globalFanScoreChangeInfo>
            <changedScore>-1200</changedScore>
            <changeTime>20140221172139</changeTime>
        </globalFanScoreChangeInfo>
    </changeRecords>
</Response>
 

1.9.7 接口响应码

响应码

描述

8000

阅读号为空

8001

阅读号非法

4003

start为空

4004

start非法

4005

count为空

4006

count非法

8030

changeType为空

8031

changeType非整数

8032

changeType非法

2000

other

1.10 promoteGlobalFanLevel 全站粉丝等级升级接口

1.10.1 接口描述

全站粉丝等级升级

1.10.2 最后修改信息

1.10.3 调用方

1.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

reachedLevel

Request

int

1

升到的等级

响应消息体

字段名

父字段名

字段类型

出现次数

描述

currentLevel

Response

int

1

升级后的等级

deductedScore

Response

long

1

消耗的粉丝值

remainingScore

Response

long

1

剩余的粉丝值

1.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

1.10.6 报文样例

请求方法

 
POST /portalapi/promoteGlobalFanLevel

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <reachedLevel>2</reachedLevel>
</Request>
 

响应报文

  
<Response>
    <currentLevel>2</currentLevel>
    <deductedScore>1200</deductedScore>
    <remainingScore>98800</remainingScore>
</Response>
 

1.10.7 接口响应码

响应码

描述

8000

阅读号为空

8001

阅读号非法

8016

升级到的等级为空

8017

升级到的等级越界

8016

升级到的等级不合法

8018

升级到的等级不大于当前等级

8019

用户全站粉丝等级信息为空

8020

升级所需的粉丝值不足

2000

other

2 CMI13

2.1 apply4CertifiedAuthor 作家认证申请接口

2.1.1 接口描述

作家认证申请接口

2.1.2 最后修改信息

2.1.3 调用方

2.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

penName

Request

String

1

笔名

realName

Request

String

1

姓名

idCardNum

Request

String

1

身份证号

certificatePath

Request

String

1

身份证扫描件(正)url

unCertificatePath

Request

String

1

身份证扫描件(反)url

authorMobile

Request

String

1

手机号码

qqNum

Request

String

1

QQ

describe

Request

String

1

作者简介

burse

Request

String

1

手机钱包账号

mail

Request

String

0...1

站内信

status

Request

String

1

认证状态

isCopy

Request

String

1

是否副本:1、是 0、否

classify

Request

String

1

分类:1、原创 2、出版 3、女频

createTime

Request

Date

1

申请认证时间

signstatus

Request

String

0...1

合同状态

endTime

Request

Date

0...1

认证完成时间

signTime

Request

Date

0...1

合同签约日期:1、是 0、否

expireTime

Request

Date

0...1

合同到期日期:1、是 0、否

响应消息体

字段名

父字段名

字段类型

出现次数

描述

2.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.1.6 报文样例

请求方法

 
POST /portalapi/apply4CertifiedAuthor

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <penName></penName>
    <realName></realName>
    <idCardNum></idCardNum>
    <certificatePath></certificatePath>
    <unCertificatePath></unCertificatePath>
    <authorMobile></authorMobile>
    <qqNum></qqNum>
    <describe></describe>
    <burse></burse>
    <mail></mail>
    <status></status>
    <isCopy></isCopy>
    <classify></classify>
    <createTime></createTime>
    <signstatus></signstatus>
    <endTime></endTime>
    <signTime></signTime>
    <expireTime></expireTime>
</Request>
 

响应报文

  
<Response></Response>
 

2.1.7 接口响应码

响应码

描述

9600

阅读号为空

9601

阅读号非法

9602

笔名为空

9603

姓名为空

9604

身份证扫描件(正)url为空

9605

身份证扫描件(反)url为空

9606

QQ号为空

9607

作者简介为空

9608

手机钱包帐号为空

9609

认证状态为空

9620

是否副本为空

9621

分类为空

9622

申请认证时间为空

200

数据插入成功

2000

其他异常

2.2 apply4Paying 支付申请接口

2.2.1 接口描述

支付申请接口

2.2.2 最后修改信息

2.2.3 调用方

2.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

requestId

Request

String

1

序列号

receiveNo

Request

String

1

手机钱包ID

remark

Request

String

1

支付方式:1.月票支付2.打赏支付

amount

Request

String

1

月票支付金额/打赏支付金额

响应消息体

字段名

父字段名

字段类型

出现次数

描述

2.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.2.6 报文样例

请求方法

 
POST /portalapi/apply4Paying

请求报文

 
<Request>
    <requestId>65855</requestId>
    <receiveNo>15214584512</receiveNo>
    <remark>1</remark>
    <amount>1</amount>
</Request>
 

响应报文

  
<Response></Response>
 

2.2.7 接口响应码

响应码

描述

200

success

XXX

XXX

2.3 authorPayRequest 支付申请接口

2.3.1 接口描述

作家支付申请接口

2.3.2 最后修改信息

2.3.3 调用方

2.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

payRequestList

Request

List

1

Item

payRequestList

1..n

requestId

Item

String

1

序列号,同支付接口中的requestId

receiveNo

Item

String

1

手机钱包ID,同支付接口中的receiveNo

remark

Item

String

1

月票支付/打赏支付,两者取其一

amount

Item

String

1

月票支付/打赏支付,两者取其一

响应消息体

字段名

父字段名

字段类型

出现次数

描述

status

Response

String

1

状态

2.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.3.6 报文样例

请求方法

 
POST /portalapi/authorPayRequest

请求报文

 
<Request>
    <payRequestList>
        <Item>
            <requestId></requestId>
            <receiveNo></receiveNo>
            <remark></remark>
            <amount></amount>
        </Item>
    </payRequestList>
</Request>
 

响应报文

  
<Response>
    <status></status>
</Response>
 

2.3.7 接口响应码

响应码

描述

9610

支付请求list为空

9611

支付请求项Item为空

9612

requestId为空

9613

amount为空

9614

remark为空

9615

receiveNo为空

2.4 batchUpdateVipLevelScore 会员等级积分批量下发接口

2.4.1 接口描述

会员等级积分批量下发

2.4.2 最后修改信息

2.4.3 调用方

2.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

batchUpdateVipScoreList

Request

List

0...1

等级积分批量下发请求列表

BatchUpdateVipScore

batchUpdateVipScoreList

BatchUpdateVipScore

0...N

批量下发单个请求体

msisdn

BatchUpdateVipScore

String

1

阅读号

socre

BatchUpdateVipScore

Long

1

积分

响应消息体

字段名

父字段名

字段类型

出现次数

描述

succeed

Response

int

1

保存成的记录数

defeated

Response

int

1

保存失败的记录数

2.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.4.6 报文样例

请求方法

 
POST /portalapi/batchUpdateVipLevelScore

请求报文

 
<Request>
    <batchUpdateVipScoreList>
        <BatchUpdateVipScore>
            <msisdn>18745678910</msisdn>
            <socre>1000</socre>
        </BatchUpdateVipScore>
        <BatchUpdateVipScore>
            <msisdn>1325678910</msisdn>
            <socre>1000</socre>
        </BatchUpdateVipScore>
    </batchUpdateVipScoreList>
</Request>
 

响应报文

  
<Response>
    <succeed>0</succeed>
    <defeated>0</defeated>
</Response>
 

2.4.7 接口响应码

响应码

描述

10001

会员阅读号为空

10002

会员阅读号非法

10300

批量下发的会员等级积分为空

10301

批量下发的会员等级积分非法

9508

会员信息为空

10100

VIP等级积分越界

2.5 batchUpdateVipScore 批量下发接口

2.5.1 接口描述

批量下发接口

2.5.2 最后修改信息

2.5.3 调用方

2.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

batchUpdateVipScoreList

Request

0...1

批下发请求列表

com.huawei.iread.snsserver.domain.bean.vip.BatchUpdateVipScore

batchUpdateVipScoreList

0...N

msisdn

com.huawei.iread.snsserver.domain.bean.vip.BatchUpdateVipScore

String

1

阅读号

socre

com.huawei.iread.snsserver.domain.bean.vip.BatchUpdateVipScore

Long

1

积分

响应消息体

字段名

父字段名

字段类型

出现次数

描述

succeed

Response

Integer

1

成功条数

defeated

Response

Integer

1

失败条数

2.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.5.6 报文样例

请求方法

 
POST /portalapi/batchUpdateVipScore

请求报文

 
<Request>
    <batchUpdateVipScoreList>
        <com.huawei.iread.snsserver.domain.bean.vip.BatchUpdateVipScore>
            <msisdn>12345678919</msisdn>
            <socre>1000</socre>
        </com.huawei.iread.snsserver.domain.bean.vip.BatchUpdateVipScore>
    </batchUpdateVipScoreList>
</Request>
 

响应报文

  
<Response>
    <succeed>1</succeed>
    <defeated>1</defeated>
</Response>
 

2.5.7 接口响应码

响应码

描述

2.6 buyProps 购买道具接口

2.6.1 接口描述

购买道具接口

2.6.2 最后修改信息

2.6.3 调用方

2.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

propsID

Request

int

1

道具ID

quantity

Request

int

1

道具个数

payModel

Request

int

1

购买方式(1:会员积分……)

响应消息体

字段名

父字段名

字段类型

出现次数

描述

deductedNum

Response

long

1

消耗量

remainingNum

Response

long

1

剩余量

2.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.6.6 报文样例

请求方法

 
POST /portalapi/buyProps

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <propsID>1</propsID>
    <quantity>2</quantity>
    <payModel>1</payModel>
</Request>
 

响应报文

  
<Response>
    <deductedNum>1000</deductedNum>
    <remainingNum>999999</remainingNum>
</Response>
 

2.6.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9002

道具ID为空

9003

道具ID非法

9004

道具信息为null

9501

道具购买个数为空

9502

道具个数非法或者数量小于1

9503

购买方式为空

9504

购买方式非法

9505

非会员不能购买

9506

道具价格为空或为0

9507

手头有点紧

9508

会员信息为null

9509

道具不可购买

2000

other

2.7 cancelMonthPayment 取消包月产品

2.7.1 接口描述

取消包月产品

2.7.2 最后修改信息

2.7.3 调用方

2.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

productID

Request

String

1

包月产品ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

deScore

Response

String

1

扣减的等级积分

2.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.7.6 报文样例

请求方法

 
POST /portalapi/cancelMonthPayment

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <productID></productID>
</Request>
 

响应报文

  
<Response>
    <deScore>300</deScore>
</Response>
 

2.7.7 接口响应码

响应码

描述

10001

阅读号为空

10002

阅读号非法

9508

vip信息为null

10100

vip等级积分越界

2.8 getAccess2LuxuryArea 查询图书分类土豪区映射接口

2.8.1 接口描述

查询图书分类土豪区映射接口

2.8.2 最后修改信息

2.8.3 调用方

2.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

luxuryAreaInfoList

Response

List

0...1

图书分类土豪区映射列表

LuxuryAreaInfo

luxuryAreaInfoList

LuxuryAreaInfo

0...N

图书信息

classId

LuxuryAreaInfo

String

0...1

图书分类ID

className

LuxuryAreaInfo

String

0...1

分类名称

isPublish

LuxuryAreaInfo

int

0...1

是否出版

type

LuxuryAreaInfo

int

0...1

分区类型(0:原创区 1:出版区 2:女频)

ralation

LuxuryAreaInfo

int

0...1

是否属于土豪区(1:是 0)

2.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.8.6 报文样例

请求方法

 
POST /portalapi/getAccess2LuxuryArea

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <luxuryAreaInfoList>
        <LuxuryAreaInfo>
            <classId>30</classId>
            <className>玄幻</className>
            <isPublish>0</isPublish>
            <type>1</type>
            <ralation>1</ralation>
        </LuxuryAreaInfo>
    </luxuryAreaInfoList>
</Response>
 

2.8.7 接口响应码

响应码

描述

200

成功

8040

返回数据为空

2000

程序异常

2.9 getAllPropsInfoList 查询所有道具的基本信息

2.9.1 接口描述

查询所有道具的基本信息

2.9.2 最后修改信息

2.9.3 调用方

2.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

propsList

Response

List

0...1

道具列表

propsEntity

propsList

PropsEntity

0...1

道具信息

id

propsEntity

Long

1

道具ID

propsName

propsEntity

String

1

道具名称

buyType

propsEntity

short

1

购买方式

status

propsEntity

short

1

状态

vipPrice

propsEntity

Long

1

会员积分价格

propsType

propsEntity

short

1

道具类型

timeLimit

propsEntity

short

1

有效时长

effectDuration

propsEntity

short

1

效果有效期

bookID

propsEntity

String

1

书券ID

explanation

propsEntity

short

1

描述

flag

propsEntity

short

1

是否删除

largeURL

propsEntity

short

1

大图标

mediumURL

propsEntity

short

1

中图标

smallURL

propsEntity

short

1

小图标

2.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.9.6 报文样例

请求方法

 
POST /portalapi/getAllPropsInfoList

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <propsList>
        <propsEntity>
            <id>1</id>
            <propsName>加精</propsName>
            <buyType>1</buyType>
            <status>0</status>
            <vipPrice>0</vipPrice>
            <propsType>3</propsType>
            <timeLimit>4</timeLimit>
            <effectDuration>2</effectDuration>
            <bookID>0</bookID>
            <explanation>加精啊</explanation>
            <flag>1</flag>
            <largeURL>1.png</largeURL>
            <mediumURL>2.png</mediumURL>
            <smallURL>3.png</smallURL>
        </propsEntity>
    </propsList>
</Response>
 

2.9.7 接口响应码

响应码

描述

2.10 getAuthorGradeInfo 作家积分等级信息接口

2.10.1 接口描述

作家积分等级信息

2.10.2 最后修改信息

2.10.3 调用方

2.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

score

Response

int

1

levelName

Response

String

1

logoSmallUrl

Response

String

1

logoMiddleUrl

Response

String

1

logoLargeUrl

Response

String

1

2.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.10.6 报文样例

请求方法

 
POST /portalapi/getAuthorGradeInfo

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <score>作家积分</score>
    <levelName>级别名称</levelName>
    <logoSmallUrl>小图标url</logoSmallUrl>
    <logoMiddleUrl>中图标url</logoMiddleUrl>
    <logoLargeUrl>大图标url</logoLargeUrl>
</Response>
 

2.10.7 接口响应码

响应码

描述

9600

阅读号为空

9601

阅读号非法

2000

other

2.11 getAuthorizationStatus 作家认证状态查询接口

2.11.1 接口描述

作家认证状态查询接口

2.11.2 最后修改信息

2.11.3 调用方

2.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

aupenName

Response

String

1

笔名

auname

Response

String

1

姓名

idcard

Response

String

1

身份证号

aumobile

Response

String

1

手机号码

qqNum

Response

String

1

QQ

describe

Response

String

1

作者简介

burse

Response

String

1

手机钱包账号

authentication

Response

String

1

认证状态

certificatepath

Response

String

1

身份证扫描件(正)

uncertificatepath

Response

String

1

身份证扫描件(反)

isCopy

Response

String

1

是否副本:1、是 0、否

classify

Response

String

1

分类:1、原创 2、出版 3、女频

createTime

Response

String

1

申请认证时间

2.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.11.6 报文样例

请求方法

 
POST /portalapi/getAuthorizationStatus

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <aupenName></aupenName>
    <auname></auname>
    <idcard></idcard>
    <aumobile></aumobile>
    <qqNum></qqNum>
    <describe></describe>
    <burse></burse>
    <authentication></authentication>
    <certificatepath></certificatepath>
    <uncertificatepath></uncertificatepath>
    <isCopy></isCopy>
    <classify></classify>
    <createTime></createTime>
</Response>
 

2.11.7 接口响应码

响应码

描述

9600

阅读号为空

9601

阅读号非法

9650

找不到记录

2000

其他

2.12 getLevelWeightInfo 根据阅读号、图书ID、图书分类ID获取权重和等级

2.12.1 接口描述

根据阅读号、图书ID、图书分类ID获取权重和等级

2.12.2 最后修改信息

2.12.3 调用方

2.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookId

Request

String

1

图书ID

classId

Request

String

1

图书分类ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

weight

Response

String

1

权重

levelId

Response

String

1

等级ID

2.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.12.6 报文样例

请求方法

 
POST /portalapi/getLevelWeightInfo

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <bookId>201022</bookId>
    <classId>34</classId>
</Request>
 

响应报文

  
<Response>
    <weight>1</weight>
    <levelId>1</levelId>
</Response>
 

2.12.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9521

图书ID为空

9522

图书ID非法

9523

图书分类ID为空

9524

图书分类ID非法

9525

响应为空

2000

其它异常

2.13 getPrerogativeInfos 查询对应会员等级的特权信息接口

2.13.1 接口描述

查询对应会员等级的特权信息

2.13.2 最后修改信息

2.13.3 调用方

2.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

阅读号

prerogativeCode

Request

String

0...1

特权编号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

prerogativeList

Response

List

0...1

特权信息列表

PrerogativeInfo

prerogativeList

prerogativeinfo

0...1

特权信息

prerogativeId

PrerogativeInfo

String

1

特权id

prerogativeName

PrerogativeInfo

String

1

特权名称

prerogativeGradeValue

PrerogativeInfo

String

1

特权值

gradeId

PrerogativeInfo

String

1

等级id

gradeName

PrerogativeInfo

String

1

等级名称

mobile

PrerogativeInfo

String

1

阅读号

2.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.13.6 报文样例

请求方法

 
POST /portalapi/getPrerogativeInfos

请求报文

 
<Request>
    <mobile>13111111111</mobile>
    <prerogativeCode>1</prerogativeCode>
</Request>
 

响应报文

  
<Response>
    <prerogativeList>
        <PrerogativeInfo>
            <prerogativeId>1</prerogativeId>
            <prerogativeName>特权名称</prerogativeName>
            <prerogativeGradeValue>特权值</prerogativeGradeValue>
            <gradeId>1</gradeId>
            <gradeName>等级名称</gradeName>
            <mobile>13111111111</mobile>
        </PrerogativeInfo>
    </prerogativeList>
</Response>
 

2.13.7 接口响应码

响应码

描述

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

10200

获取表中字段对应的值为空

2000

其他

2.14 getPropsBuyTopList 累计道具购买次数排行

2.14.1 接口描述

累计道具购买次数排行

2.14.2 最后修改信息

2.14.3 调用方

2.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

topType

Request

int

排行类型(2:/3:)

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

propsBuyTopList

Response

List

0...1

道具购买次数排行列表

propsBuyTop

propsBuyTopList

propsTop

0...N

道具购买次数排行

propsId

propsBuyTop

int

1

道具ID

buyTotal

propsBuyTop

int

1

购买次数

2.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.14.6 报文样例

请求方法

 
POST /portalapi/getPropsBuyTopList

请求报文

 
<Request>
    <topType>1</topType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>5</resultTotal>
    <propsBuyTopList>
        <propsBuyTop>
            <propsId>111</propsId>
            <buyTotal>1235</buyTotal>
        </propsBuyTop>
        <propsBuyTop>
            <propsId>112</propsId>
            <buyTotal>900</buyTotal>
        </propsBuyTop>
        <propsBuyTop>
            <propsId>113</propsId>
            <buyTotal>810</buyTotal>
        </propsBuyTop>
    </propsBuyTopList>
</Response>
 

2.14.7 接口响应码

响应码

描述

9201

排行类型为空

9202

排行类型非法

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

other

2.15 getPropsCanBuyList 用户可购买的道具列表

2.15.1 接口描述

用户可购买的道具列表

2.15.2 最后修改信息

2.15.3 调用方

2.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

propsType

Request

string

1

道具类型(1:普通道具、2:书券道具、3:礼包)

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

propsCanBuyList

Response

List

0...1

道具信息列表

propsCanBuy

propsCanBuyList

PropsInfo

0...N

道具信息

propsId

propsCanBuy

int

1

道具ID

2.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.15.6 报文样例

请求方法

 
POST /portalapi/getPropsCanBuyList

请求报文

 
<Request>
    <propsType>1,2</propsType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>3</resultTotal>
    <propsCanBuyList>
        <propsCanBuy>
            <propsId>112</propsId>
        </propsCanBuy>
        <propsCanBuy>
            <propsId>113</propsId>
        </propsCanBuy>
        <propsCanBuy>
            <propsId>114</propsId>
        </propsCanBuy>
    </propsCanBuyList>
</Response>
 

2.15.7 接口响应码

响应码

描述

8200

道具类型为空

8201

道具类型非法

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

other

2.16 getPropsUseTopList 累计道具使用次数排行

2.16.1 接口描述

累计道具使用次数排行

2.16.2 最后修改信息

2.16.3 调用方

2.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

topType

Request

int

排行类型(2:/3:)

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

propsUseTopList

Response

List

0...1

道具使用次数排行列表

propsUseTop

propsUseTopList

propsTop

0...N

道具使用次数排行

propsId

propsUseTop

int

1

道具ID

useTotal

propsUseTop

int

1

使用次数

2.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.16.6 报文样例

请求方法

 
POST /portalapi/getPropsUseTopList

请求报文

 
<Request>
    <topType>1</topType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>5</resultTotal>
    <propsUseTopList>
        <propsUseTop>
            <propsId>111</propsId>
            <useTotal>1000</useTotal>
        </propsUseTop>
        <propsUseTop>
            <propsId>112</propsId>
            <useTotal>700</useTotal>
        </propsUseTop>
        <propsUseTop>
            <propsId>113</propsId>
            <useTotal>600</useTotal>
        </propsUseTop>
    </propsUseTopList>
</Response>
 

2.16.7 接口响应码

响应码

描述

9201

排行类型为空

9202

排行类型非法

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

other

2.17 getTieModelList 获取帖子模板信息列表

2.17.1 接口描述

获取帖子模板信息列表

2.17.2 最后修改信息

2.17.3 调用方

2.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

tieModelList

Response

tieModelInfo

tieModelList

modelType

tieModelInfo

String

1

类型(1:订购:2:打赏:3:投月票)

modelName

tieModelInfo

String

1

标题

modelContent

tieModelInfo

String

1

内容

2.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.17.6 报文样例

请求方法

 
POST /portalapi/getTieModelList

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <total>1</total>
    <tieModelList>
        <tieModelInfo>
            <modelType>1</modelType>
            <modelName>test</modelName>
            <modelContent>test</modelContent>
        </tieModelInfo>
    </tieModelList>
</Response>
 

2.17.7 接口响应码

响应码

描述

2000

其它异常

2.18 getUserMonthTicket 查询用户赠送的月票总数

2.18.1 接口描述

查询用户赠送的月票总数

2.18.2 最后修改信息

2.18.3 调用方

2.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

vip

Request

String

1

是否会员

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalcount

Response

int

1

月票总数

2.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.18.6 报文样例

请求方法

 
POST /portalapi/getUserMonthTicket

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <vip>0</vip>
</Request>
 

响应报文

  
<Response>
    <totalcount>30</totalcount>
</Response>
 

2.18.7 接口响应码

响应码

描述

200

查询成功

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

40021

是否会员为空

2000

other

2.19 getUserPorpsBuyRecordList 根据阅读号查询指定用户购买道具的历史记录信息

2.19.1 接口描述

根据阅读号查询指定用户购买道具的时间、数量、消费值、消费类型和道具基本信息列表

2.19.2 最后修改信息

2.19.3 调用方

2.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

userPorpsBuyList

Response

userBuyPropsInfo

userPorpsBuyList

id

userBuyPropsInfo

String

1

道具ID

propsName

userBuyPropsInfo

String

1

道具名称

buyTime

userBuyPropsInfo

String

1

购买的时间

propsNum

userBuyPropsInfo

String

1

购买数量

buyTotal

userBuyPropsInfo

String

1

消费值

buyType

userBuyPropsInfo

String

1

消费类型(1:会员积分)

2.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.19.6 报文样例

请求方法

 
POST /portalapi/getUserPorpsBuyRecordList

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <total>1</total>
    <userPorpsBuyList>
        <userBuyPropsInfo>
            <id>1</id>
            <propsName>置顶</propsName>
            <buyTime>2013-03-12 12:20:20</buyTime>
            <propsNum>2</propsNum>
            <buyTotal>200</buyTotal>
            <buyType>1</buyType>
        </userBuyPropsInfo>
    </userPorpsBuyList>
</Response>
 

2.19.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

其它异常

2.20 getUserPropsbyId 根据阅读号、道具ID 查询指定用户指定道具基本信息和数量

2.20.1 接口描述

根据阅读号、道具ID 查询指定用户指定道具基本信息和数量

2.20.2 最后修改信息

2.20.3 调用方

2.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

propsId

Request

String

1

道具ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

userPropsInfoList

Response

userPropsInfo

userPropsInfoList

id

userPropsInfo

String

1

道具ID

propsName

userPropsInfo

String

1

道具名称

outTime

userPropsInfo

String

1

到期时间

propsNum

userPropsInfo

String

1

数量

expireDays

userPropsInfo

String

1

到期天数

userPropsInfo

userPropsInfoList

id

userPropsInfo

String

1

道具ID

propsName

userPropsInfo

String

1

道具名称

outTime

userPropsInfo

String

1

到期时间

propsNum

userPropsInfo

String

1

数量

expireDays

userPropsInfo

String

1

到期天数

2.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.20.6 报文样例

请求方法

 
POST /portalapi/getUserPropsbyId

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <propsId>1</propsId>
</Request>
 

响应报文

  
<Response>
    <total>1</total>
    <userPropsInfoList>
        <userPropsInfo>
            <id>1</id>
            <propsName>置顶</propsName>
            <outTime>2014-04-30</outTime>
            <propsNum>2</propsNum>
            <expireDays>6</expireDays>
        </userPropsInfo>
        <userPropsInfo>
            <id>1</id>
            <propsName>置顶</propsName>
            <outTime>2014-04-28</outTime>
            <propsNum>1</propsNum>
            <expireDays>4</expireDays>
        </userPropsInfo>
    </userPropsInfoList>
</Response>
 

2.20.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9002

道具ID为空

9003

道具ID非法

2000

其它异常

2.21 getUserPropsList 根据阅读号、道具类型、到期类型查询指定用户拥有的道具基本信息和数量列表

2.21.1 接口描述

根据阅读号、道具类型(支持枚举)、到期类型查询指定用户拥有的道具基本信息和数量列表

2.21.2 最后修改信息

2.21.3 调用方

2.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

propsType

Request

String

1

道具类型(1:普通道具、2:书券道具、3:礼包)

expireType

Request

String

1

到期类型(0:非7天内到期、17天内到期、2:全部)

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

totalnum

Response

int

1

所有道具总量

userPropsInfoResult

Response

userPropsInfo

userPropsInfoResult

id

userPropsInfo

String

1

道具ID

propsName

userPropsInfo

String

1

道具名称

outTime

userPropsInfo

String

1

到期时间

propsNum

userPropsInfo

String

1

数量

expireDays

userPropsInfo

String

1

到期天数

2.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.21.6 报文样例

请求方法

 
POST /portalapi/getUserPropsList

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <propsType>1,2,3</propsType>
    <expireType>0</expireType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <total>1</total>
    <totalnum>1</totalnum>
    <userPropsInfoResult>
        <userPropsInfo>
            <id>1</id>
            <propsName>置顶</propsName>
            <outTime>2014-04-30</outTime>
            <propsNum>2</propsNum>
            <expireDays>6</expireDays>
        </userPropsInfo>
    </userPropsInfoResult>
</Response>
 

2.21.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

8200

道具类型为空

8201

道具类型非法

8202

到期类型为空

8203

到期类型非法

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

其它异常

2.22 getUserPropsUseRecordList 根据阅读号查询指定用户的道具使用记录

2.22.1 接口描述

根据阅读号查询指定用户已过期或已使用道具类型名称、道具使用的时间、数量和道具基本列表信息

2.22.2 最后修改信息

2.22.3 调用方

2.22.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

userPorpsUseList

Response

usePropsInfo

userPorpsUseList

id

usePropsInfo

String

1

道具ID

propsName

usePropsInfo

String

1

道具名称

useTime

usePropsInfo

String

1

使用的时间

outTime

usePropsInfo

String

1

到期时间

propsNum

usePropsInfo

String

1

数量

2.22.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.22.6 报文样例

请求方法

 
POST /portalapi/getUserPropsUseRecordList

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <total>1</total>
    <userPorpsUseList>
        <usePropsInfo>
            <id>1</id>
            <propsName>置顶</propsName>
            <useTime>2013-03-22 10:20:20</useTime>
            <outTime></outTime>
            <propsNum>2</propsNum>
        </usePropsInfo>
    </userPorpsUseList>
</Response>
 

2.22.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

2000

其它异常

2.23 getUserVipInfo 查询会员等级积分接口

2.23.1 接口描述

查询会员等级积分接口

2.23.2 最后修改信息

2.23.3 调用方

2.23.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

vipLevel

Response

int

1

会员等级

levelName

Response

String

1

会员等级名称

levelScore

Response

long

1

等级积分

vipScore

Response

long

1

可消费积分

deVipScore

Response

long

1

可消费积分扣减总量

largeURL

Response

short

1

大图标

mediumURL

Response

short

1

中图标

smallURL

Response

short

1

小图标

2.23.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.23.6 报文样例

请求方法

 
POST /portalapi/getUserVipInfo

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <vipLevel>3</vipLevel>
    <levelName>3</levelName>
    <levelScore>999999</levelScore>
    <vipScore>999999</vipScore>
    <deVipScore>999999</deVipScore>
    <largeURL>1.png</largeURL>
    <mediumURL>2.png</mediumURL>
    <smallURL>3.png</smallURL>
</Response>
 

2.23.7 接口响应码

响应码

描述

9508

用户会员信息返回出错

4000

手机号为空

4001

手机号非法

4002

手机号长度错误

10021

用户等级名称返回数据出错

10032

会员等级图标返回数据出错

2.24 getVipLevelRules 查询会员等级规则接口

2.24.1 接口描述

查询会员等级规则接口

2.24.2 最后修改信息

2.24.3 调用方

2.24.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

vipList

Response

List

0...1

等级信息列表

vip

vipList

VipInfo

0...1

等级信息

level

vip

Integer

0...1

等级

levelName

vip

String

0...1

等级名称

lowerScore

vip

Integer

0...1

下限分

upperScore

vip

Integer

0...1

上限分

largeURL

vip

String

1

大图标

mediumURL

vip

String

1

中图标

smallURL

vip

String

1

小图标

2.24.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.24.6 报文样例

请求方法

 
POST /portalapi/getVipLevelRules

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <vipList>
        <vip>
            <level>1</level>
            <levelName>1</levelName>
            <lowerScore>1</lowerScore>
            <upperScore>1</upperScore>
            <largeURL>1.png</largeURL>
            <mediumURL>2.png</mediumURL>
            <smallURL>3.png</smallURL>
        </vip>
    </vipList>
</Response>
 

2.24.7 接口响应码

响应码

描述

2000

其他错误

10009

会员等级规则返回数据为空

2.25 getVipLevelScoreDeductionDetail 查询会员等级积分扣减明细接口

2.25.1 接口描述

查询会员等级积分扣减明细接口

2.25.2 最后修改信息

2.25.3 调用方

2.25.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

deVipLevelScoreInfoList

Response

List

0...1

会员等级积分扣减明细列表

deVipLevelScoreInfo

deVipLevelScoreInfoList

DeVipLevelScoreInfo

0...1

会员等级积分扣减明细

time

deVipLevelScoreInfo

String

0...1

时间

desc

deVipLevelScoreInfo

String

0...1

描述

deScore

deVipLevelScoreInfo

int

0...1

扣减分值

2.25.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.25.6 报文样例

请求方法

 
POST /portalapi/getVipLevelScoreDeductionDetail

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>5</total>
    <deVipLevelScoreInfoList>
        <deVipLevelScoreInfo>
            <time>1</time>
            <desc></desc>
            <deScore></deScore>
        </deVipLevelScoreInfo>
    </deVipLevelScoreInfoList>
</Response>
 

2.25.7 接口响应码

响应码

描述

2000

其他错误

10001

阅读号为空

10002

阅读号非法

10003

起始位置为空

10004

起始位置非数字

10005

条数为空

10006

条数非数字

2.26 getVipPrivileges 会员特权查询接口

2.26.1 接口描述

会员特权查询接口

2.26.2 最后修改信息

2.26.3 调用方

2.26.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

vipList

Response

List

0...1

等级特权信息列表

vip

vipList

VipInfo

0...1

等级特权信息

level

vip

Integer

0...1

等级

privileges

vip

List

0...1

特权列表

privilege

privileges

PrivilegeInfo

0...1

特权

id

privilege

Integer

0...1

特权ID

name

privilege

String

0...1

特权名称

value

privilege

String

0...1

特权值

2.26.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.26.6 报文样例

请求方法

 
POST /portalapi/getVipPrivileges

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <vipList>
        <vip>
            <level>1</level>
            <privileges>
                <privilege>
                    <id>1</id>
                    <name>道具折扣</name>
                    <value>折扣率</value>
                </privilege>
            </privileges>
        </vip>
    </vipList>
</Response>
 

2.26.7 接口响应码

响应码

描述

2000

其他错误

10008

会员特权信息查询为空

2.27 getVipScoreDeductionDetail 查询会员消费积分扣减明细接口

2.27.1 接口描述

查询会员消费积分扣减明细接口

2.27.2 最后修改信息

2.27.3 调用方

2.27.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

int

1

总记录数

deVipScoreInfoList

Response

List

0...1

会员消费积分扣减明细列表

DeVipScoreInfo

deVipScoreInfoList

DeVipScoreInfo

0...1

会员消费积分扣减明细

time

DeVipScoreInfo

String

0...1

时间

desc

DeVipScoreInfo

String

0...1

描述

deScore

DeVipScoreInfo

int

0...1

扣减分值

2.27.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.27.6 报文样例

请求方法

 
POST /portalapi/getVipScoreDeductionDetail

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>5</total>
    <deVipScoreInfoList>
        <DeVipScoreInfo>
            <time>1</time>
            <desc></desc>
            <deScore></deScore>
        </DeVipScoreInfo>
    </deVipScoreInfoList>
</Response>
 

2.27.7 接口响应码

响应码

描述

4000

手机号为空

4001

手机号非法

4002

手机号长度错误

10003

起始位置为空

10005

条数为空

10004

起始位置非法

10006

条数非法

10043

会员可消费积分返回出错

2.28 propsRecommend 道具推荐列表接口

2.28.1 接口描述

道具推荐列表

2.28.2 最后修改信息

2.28.3 调用方

2.28.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

propsid

Request

String

1

道具ID

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

buytotal

Response

int

1

总购买人数

totalCount

Response

1

记录总数

PropsList

Response

List

0...1

推荐道具信息

RecommandPropsInfo

PropsList

RecommandPropsInfo

0...N

推荐道具信息

propsID

RecommandPropsInfo

1

道具ID

num

RecommandPropsInfo

int

1

购买人数

2.28.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.28.6 报文样例

请求方法

 
POST /portalapi/propsRecommend

请求报文

 
<Request>
    <propsid></propsid>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <buytotal>5</buytotal>
    <totalCount>1</totalCount>
    <PropsList>
        <RecommandPropsInfo>
            <propsID>1</propsID>
            <num>3353</num>
        </RecommandPropsInfo>
    </PropsList>
</Response>
 

2.28.7 接口响应码

响应码

描述

200

成功

9002

道具ID为空

9003

道具ID不合法

9005

查询不到该道具推荐信息

9203

start为空

9204

start非法

9205

count为空

9206

count非法

2000

other

2.29 reduceLevelScore4DelForumPosts 等级积分扣减接口

2.29.1 接口描述

等级积分扣减接口(1.删贴;2.删除书单;3.取消关注……)

2.29.2 最后修改信息

2.29.3 调用方

2.29.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

eventType

Request

int

1

触发事件

响应消息体

字段名

父字段名

字段类型

出现次数

描述

deScore

Response

String

1

扣减的等级积分

2.29.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.29.6 报文样例

请求方法

 
POST /portalapi/reduceLevelScore4DelForumPosts

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <eventType>1</eventType>
</Request>
 

响应报文

  
<Response>
    <deScore>300</deScore>
</Response>
 

2.29.7 接口响应码

响应码

描述

10001

阅读号为空

10002

阅读号非法

10101

触发事件为空

10102

触发事件非法

9508

vip信息为null

10100

vip等级积分越界

2.30 unpack 礼包下发接口方法

2.30.1 接口描述

礼包下发接口方法

2.30.2 最后修改信息

2.30.3 调用方

2.30.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

packageID

Request

int

1

ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultCode

Response

int

1

接口返回码.200:成功;9580:礼包过期

usefulList

Response

List

0...1

可用道具列表

props

usefulList

PackageProps

0...N

道具信息

id

props

int

0...1

道具ID

num

props

int

0...1

数量

uselessList

Response

List

0...1

下架道具列表

props

uselessList

PackageProps

0...N

道具信息

id

props

int

0...1

道具ID

num

props

int

0...1

数量

deletedList

Response

List

0...1

已删除道具列表

props

deletedList

PackageProps

0...N

道具信息

id

props

int

0...1

道具ID

num

props

int

0...1

数量

allList4Exception

Response

List

0...1

礼包中的所有道具集合(resultCode =200 时,此集合size0)

props

allList4Exception

PackageProps

0...N

道具信息

id

props

int

0...1

道具ID

num

props

int

0...1

数量

2.30.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.30.6 报文样例

请求方法

 
POST /portalapi/unpack

请求报文

 
<Request>
    <msisdn>18700000000
           </msisdn>
    <packageID>1</packageID>
</Request>
 

响应报文

  
<Response>
    <resultCode>200</resultCode>
    <usefulList>
        <props>
            <id>1</id>
            <num>1</num>
        </props>
    </usefulList>
    <uselessList>
        <props>
            <id>1</id>
            <num>1</num>
        </props>
    </uselessList>
    <deletedList>
        <props>
            <id>1</id>
            <num>1</num>
        </props>
    </deletedList>
    <allList4Exception>
        <props>
            <id>1</id>
            <num>1</num>
        </props>
    </allList4Exception>
</Response>
 

2.30.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9002

礼包道具ID为空

9003

礼包道具ID非法

9520

无礼包道具

9581

礼包中无道具

2000

other

2.31 updateAuthorizationStatus 作家合同状态变更接口

2.31.1 接口描述

作家合同状态变更接口

2.31.2 最后修改信息

2.31.3 调用方

2.31.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

transactionId

Request

Integer

1

transactionId

idNumber

Request

Integer

1

身份证号码

cmreadId

Request

String

1

阅读号

signstatus

Request

Integer

1

合同状态

signDate

Request

Integer

1

状态更新时间

响应消息体

字段名

父字段名

字段类型

出现次数

描述

returnCode

Response

Integer

1

返回结果(0:成功;1:失败)

transactionId

Response

Integer

1

transactionId

2.31.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.31.6 报文样例

请求方法

 
POST /portalapi/updateAuthorizationStatus

请求报文

 
<Request>
    <transactionId>12312312312312312312</transactionId>
    <idNumber>351568199102185353</idNumber>
    <cmreadId>18700000000</cmreadId>
    <signstatus>3</signstatus>
    <signDate>2014-05-20 20:44:20</signDate>
</Request>
 

响应报文

  
<Response>
    <returnCode>0</returnCode>
    <transactionId>12312312312312312312</transactionId>
</Response>
 

2.31.7 接口响应码

响应码

描述

4000

阅读号位空

4001

阅读号非法

4002

阅读号长度错误,非11

9672

合同状态类型错误

9673

合同变更状态类型为空

9674

transactionId为空

9675

transactionId非法

9676

身份证号码为空

9677

身份证号码非法

2.32 useProps 用户使用道具接口

2.32.1 接口描述

用户使用道具

2.32.2 最后修改信息

2.32.3 调用方

2.32.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

propsid

Request

String

1

道具ID

useNum

Request

String

1

道具数量

postid

Request

String

0...1

帖子ID

sectionid

Request

String

0...1

版块ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

2.32.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

2.32.6 报文样例

请求方法

 
POST /portalapi/useProps

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <propsid></propsid>
    <useNum></useNum>
    <postid></postid>
    <sectionid></sectionid>
</Request>
 

响应报文

  
<Response></Response>
 

2.32.7 接口响应码

响应码

描述

200

道具使用成功

9000

阅读号为空

9001

阅读号非法

9002

道具ID为空

9003

道具ID不合法

9010

道具数量为空

9011

道具数量不合法

9209

帖子ID为空

9210

帖子ID不合法

9211

版块ID为空

9212

版块ID不合法

9100

道具信息表无此道具,或该道具已下架或删除

9200

该道具不是书券道具和论坛道具

9217

没有该道具的购买信息

9215

道具数量不足,无法使用

9218

有道具过期,无法使用

9216

论坛道具不能使用多个

9213

调用书券领取接口失败

9214

调用论坛使用道具接口失败

9219

道具使用重复了

2000

other

3 CMI14

3.1 addBooksToOneSheet 往单个书单添加多本图书

3.1.1 接口描述

多本图书加入单个书单

3.1.2 最后修改信息

3.1.3 调用方

3.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

msisdn

Request

String

1

阅读号

bookList

Request

List

1

图书id集合

string

bookList

String

1...100

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

successNum

Response

String

1

添加图书成功数量

errorNum

Response

String

1

添加图书失败数量

errorBookList

Response

List

0...1

添加失败图书id的集合

string

errorBookList

String

0...100

图书ID

3.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.1.6 报文样例

请求方法

 
POST /portalapi/addBooksToOneSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
    <bookList>
        <string>1000</string>
    </bookList>
</Request>
 

响应报文

  
<Response>
    <successNum></successNum>
    <errorNum></errorNum>
    <errorBookList>
        <string>1000</string>
    </errorBookList>
</Response>
 

3.1.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500530

图书ID为空

500513

书单图书超出最大限制

500511

添加图书异常

500516

书单ID格式错误

3.2 addBookToMultipleSheet 单本图书添加到多个书单

3.2.1 接口描述

单本图书添加到多个书单

3.2.2 最后修改信息

3.2.3 调用方

3.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookid

Request

String

1

图书ID

msisdn

Request

String

1

阅读号

bookSheetList

Request

List

1

书单id集合

string

bookSheetList

String

1...20

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

successNum

Response

String

1

添加图书成功数量

errorNum

Response

String

1

添加图书失败数量

errorBookSheetList

Response

List

0...1

添加失败书单ID的集合

string

errorBookSheetList

String

0...20

图书ID

3.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.2.6 报文样例

请求方法

 
POST /portalapi/addBookToMultipleSheet

请求报文

 
<Request>
    <bookid>1000</bookid>
    <msisdn>13712345678</msisdn>
    <bookSheetList>
        <string>1000</string>
    </bookSheetList>
</Request>
 

响应报文

  
<Response>
    <successNum></successNum>
    <errorNum></errorNum>
    <errorBookSheetList>
        <string>1000</string>
    </errorBookSheetList>
</Response>
 

3.2.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500530

图书ID为空

500531

书单ID超过限制

500511

添加图书异常

500516

书单ID格式错误

3.3 addReviewScoreRecord 给图书评分记录

3.3.1 接口描述

记录该用户本次的评分操作

3.3.2 最后修改信息

3.3.3 调用方

3.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookId

Request

String

1

图书ID

isFirstReview

Request

int

1

是否是首次评分,0代表是,1代表不是

bookFansScore

Request

long

1

用户这本书的图书粉丝值

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.3.6 报文样例

请求方法

 
POST /portalapi/addReviewScoreRecord

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <bookId>3578098</bookId>
    <isFirstReview>0</isFirstReview>
    <bookFansScore>110</bookFansScore>
</Request>
 

响应报文

  
<Response></Response>
 

3.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

4504

图书ID为空

7008

图书ID超过最大长度

80085

是否评分字段非法非法

3.4 batchClickBookSheets 书单点击量批处理接口

3.4.1 接口描述

书单点击量批处理接口

3.4.2 最后修改信息

3.4.3 调用方

3.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetClickList

Request

String

0...N

批处理列表

SheetClick

sheetClickList

String

0...N

书单点击

sheetId

SheetClick

String

1

书单ID

clickTimes

SheetClick

int

1

点击次数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.4.6 报文样例

请求方法

 
POST /portalapi/batchClickBookSheets

请求报文

 
<Request>
    <sheetClickList>
        <SheetClick>
            <sheetId>1</sheetId>
            <clickTimes>1000</clickTimes>
        </SheetClick>
    </sheetClickList>
</Request>
 

响应报文

  
<Response></Response>
 

3.4.7 接口响应码

响应码

描述

200

success

10601

书单ID不存在

10602

书单点击量非法

10603

书单点击量为空

10604

书单已删除

10605

书单点击失败

500507

书单ID不能为空

500516

书单ID非法

2000

other

3.5 deleteNewSheetDynamic 删除最新动态中的书单接口

3.5.1 接口描述

删除最新动态中的书单接口

3.5.2 最后修改信息

3.5.3 调用方

3.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetId

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

returnCode

Response

Integer

1

返回结果(1:删除成功;0:失败)

3.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.5.6 报文样例

请求方法

 
POST /portalapi/deleteNewSheetDynamic

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <sheetId>100146</sheetId>
</Request>
 

响应报文

  
<Response>
    <returnCode>0</returnCode>
</Response>
 

3.5.7 接口响应码

响应码

描述

11001

阅读号为空

11002

阅读号非法

11003

书单ID为空

11004

书单ID非法

2000

其它异常

3.6 getAuthorRankingList 获取作家排行榜

3.6.1 接口描述

获取作家排行榜

3.6.2 最后修改信息

3.6.3 调用方

3.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

type

Request

String

1

类型( 0:总榜)

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

authorList

Response

List

0...1

排行榜列表

AuthorRanking

authorList

1...N

ranking

AuthorRanking

String

1

排名

authorID

AuthorRanking

String

1

作家id

scroe

AuthorRanking

String

1

积分

3.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.6.6 报文样例

请求方法

 
POST /portalapi/getAuthorRankingList

请求报文

 
<Request>
    <type>1</type>
    <start>1</start>
    <count>100</count>
</Request>
 

响应报文

  
<Response>
    <totalCount></totalCount>
    <authorList>
        <AuthorRanking>
            <ranking>1</ranking>
            <authorID>1222</authorID>
            <scroe>1</scroe>
        </AuthorRanking>
    </authorList>
</Response>
 

3.6.7 接口响应码

响应码

描述

2000

其他错误

500540

类型格式不正确

500541

类型为空

500542

获取榜单失败

500543

起始位置非法

500544

条数非法

500545

起始位置为空

500546

条数为空

3.7 getBookSheetInfo 获取书单信息详情接口

3.7.1 接口描述

根据书单ID查询书单详情信息

3.7.2 最后修改信息

3.7.3 调用方

3.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetInfo

Response

BookSheetInfo

0...1

书单信息

sheetid

sheetInfo

String

1

书单Id

msisdn

sheetInfo

String

1

阅读号

title

sheetInfo

String

1

书单标题

sheetdesc

sheetInfo

String

0...1

书单描述

sharenum

sheetInfo

String

1

书单分享次数

booknum

sheetInfo

String

1

书单书目个数

clickTimes

sheetInfo

String

1

点击量

glorifiedTimes

sheetInfo

String

1

点赞量

permission

sheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

sheetInfo

String

1

书单状态 0:正常 1:删除

createtime

sheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

3.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.7.6 报文样例

请求方法

 
POST /portalapi/getBookSheetInfo

请求报文

 
<Request>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <sheetInfo>
        <sheetid>3000739</sheetid>
        <msisdn>15077870000</msisdn>
        <title>书单一</title>
        <sheetdesc>书单一的描述</sheetdesc>
        <sharenum>0</sharenum>
        <booknum>3</booknum>
        <clickTimes>100</clickTimes>
        <glorifiedTimes>100</glorifiedTimes>
        <permission>1</permission>
        <status>0</status>
        <createtime>20130930152040</createtime>
    </sheetInfo>
</Response>
 

3.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

500507

书单ID为空

500516

书单ID非法

3.8 getBookSheetsByUser 获取用户书单列表接口

3.8.1 接口描述

根据手机号查询用户的所有书单信息

3.8.2 最后修改信息

3.8.3 调用方

3.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1创建时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

sheetList

Response

List

0...1

书单列表

BookSheetInfo

sheetList

BookSheetInfo

1...N

书单信息

sheetid

BookSheetInfo

String

1

书单Id

msisdn

BookSheetInfo

String

1

阅读号

title

BookSheetInfo

String

1

书单标题

sheetdesc

BookSheetInfo

String

0...1

书单描述

sharenum

BookSheetInfo

String

1

书单分享次数

booknum

BookSheetInfo

String

1

书单书目个数

clickTimes

BookSheetInfo

String

1

点击量

glorifiedTimes

BookSheetInfo

String

1

点赞量

permission

BookSheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

BookSheetInfo

String

1

书单状态 0:正常 1:删除

createtime

BookSheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

3.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.8.6 报文样例

请求方法

 
POST /portalapi/getBookSheetsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <sheetList>
        <BookSheetInfo>
            <sheetid>3000739</sheetid>
            <msisdn>15077870000</msisdn>
            <title>书单一</title>
            <sheetdesc>书单一的描述</sheetdesc>
            <sharenum>0</sharenum>
            <booknum>3</booknum>
            <clickTimes>100</clickTimes>
            <glorifiedTimes>100</glorifiedTimes>
            <permission>1</permission>
            <status>0</status>
            <createtime>20130930152040</createtime>
        </BookSheetInfo>
        <BookSheetInfo>
            <sheetid>3000738</sheetid>
            <msisdn>13588164850</msisdn>
            <title>书单二</title>
            <sheetdesc></sheetdesc>
            <sharenum>11</sharenum>
            <booknum>4</booknum>
            <permission>0</permission>
            <status>0</status>
            <createtime>20130930152050</createtime>
        </BookSheetInfo>
    </sheetList>
</Response>
 

3.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500514

隐私值为空

500518

隐私值非法

3.9 getBookSheetsClickTimesRankingList 查询书单点量排行榜

3.9.1 接口描述

data source :BI统计,ETL入库

3.9.2 最后修改信息

3.9.3 调用方

3.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

rankingType

Request

int

1

排行类型:0总榜,2周榜,3月榜

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

bookSheetRankingList

Response

List

0...1

书单排行列表

bookSheetRankingInfo

bookSheetRankingList

BookSheetRankingInfo

0...N

书单排行信息

rank

bookSheetRankingInfo

int

1

名次

clickTimes

bookSheetRankingInfo

long

1

点击次数

sheetId

bookSheetRankingInfo

String

1

书单ID

sheetName

bookSheetRankingInfo

String

1

书单名称

msisdn

bookSheetRankingInfo

String

1

创建者

sheetdesc

bookSheetRankingInfo

String

1

书单描述

3.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.9.6 报文样例

请求方法

 
POST /portalapi/getBookSheetsClickTimesRankingList

请求报文

 
<Request>
    <rankingType>0</rankingType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>5</resultTotal>
    <bookSheetRankingList>
        <bookSheetRankingInfo>
            <rank>1</rank>
            <clickTimes>1000</clickTimes>
            <sheetId>1000</sheetId>
            <sheetName>1000</sheetName>
            <msisdn>1000</msisdn>
            <sheetdesc>1000</sheetdesc>
        </bookSheetRankingInfo>
    </bookSheetRankingList>
</Response>
 

3.9.7 接口响应码

响应码

描述

12100

排行类型为空

12101

排行类型非法

12102

start为空

12103

start非法

12104

count为空

12105

count非法

2000

other

3.10 getBookSheetsGlorifiedTimesRankingList 查询书单点赞排行榜

3.10.1 接口描述

data source :BI统计,ETL入库

3.10.2 最后修改信息

3.10.3 调用方

3.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

rankingType

Request

int

1

排行类型:0总榜,2周榜,3月榜

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

bookSheetRankingList

Response

List

0...1

书单排行列表

bookSheetRankingInfo

bookSheetRankingList

BookSheetRankingInfo

0...N

书单排行信息

rank

bookSheetRankingInfo

int

1

名次

glorifiedTimes

bookSheetRankingInfo

long

1

点赞次数

sheetId

bookSheetRankingInfo

String

1

书单ID

sheetName

bookSheetRankingInfo

String

1

书单名称

msisdn

bookSheetRankingInfo

String

1

创建者

sheetdesc

bookSheetRankingInfo

String

1

书单描述

3.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.10.6 报文样例

请求方法

 
POST /portalapi/getBookSheetsGlorifiedTimesRankingList

请求报文

 
<Request>
    <rankingType>0</rankingType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>5</resultTotal>
    <bookSheetRankingList>
        <bookSheetRankingInfo>
            <rank>1</rank>
            <glorifiedTimes>1000</glorifiedTimes>
            <sheetId>1000</sheetId>
            <sheetName>1000</sheetName>
            <msisdn>1000</msisdn>
            <sheetdesc>1000</sheetdesc>
        </bookSheetRankingInfo>
    </bookSheetRankingList>
</Response>
 

3.10.7 接口响应码

响应码

描述

12100

排行类型为空

12101

排行类型非法

12102

start为空

12103

start非法

12104

count为空

12105

count非法

2000

other

3.11 getFreePackage 领取免费礼包接口

3.11.1 接口描述

领取免费礼包接口

3.11.2 最后修改信息

3.11.3 调用方

3.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

packageID

Request

int

1

ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.11.6 报文样例

请求方法

 
POST /portalapi/getFreePackage

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <packageID>1</packageID>
</Request>
 

响应报文

  
<Response></Response>
 

3.11.7 接口响应码

响应码

描述

9000

阅读号为空

9001

阅读号非法

9002

礼包道具ID为空

9003

礼包道具ID非法

9004

礼包不存在或不可用

9006

道具不是礼包

9007

等级不符不能领取礼包

9008

普通用户不能领取

9009

已领取过,不能重复领取

9012

会员不能领取

2000

others

200

success

3.12 getNewDynamicList 查询好友创建书单动态信息接口,改造接口

3.12.1 接口描述

查询好友创建书单动态信息接口

3.12.2 最后修改信息

3.12.3 调用方

3.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

owner

Request

String

1

手机号

attendedmobile

Request

String

1

关注手机号

type

Request

String

1

动态类型(新增类型 13:书单)

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

newDynamicInfoList

Response

String

1

最新动态信息列表

NewDynamicInfo

newDynamicInfoList

String

0...N

最新动态信息

owner

NewDynamicInfo

String

1

手机号

attendedMobile

NewDynamicInfo

String

1

关注手机号

recordId

NewDynamicInfo

String

1

记录id

type

NewDynamicInfo

String

1

动态类型

createTime

NewDynamicInfo

String

1

动态的执行时间

3.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.12.6 报文样例

请求方法

 
POST /portalapi/getNewDynamicList

请求报文

 
<Request>
    <owner>13705711111</owner>
    <attendedmobile>13588164850</attendedmobile>
    <type>12</type>
    <start>1</start>
    <count>10</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>24</totalRecordCount>
    <newDynamicInfoList>
        <NewDynamicInfo>
            <owner>13705711111</owner>
            <attendedMobile>13588164850</attendedMobile>
            <recordId>107854</recordId>
            <type>2</type>
            <createTime>20121101173330</createTime>
        </NewDynamicInfo>
    </newDynamicInfoList>
</Response>
 

3.12.7 接口响应码

响应码

描述

200

成功

2000

其它异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4602

类型为空

4603

类型不是数字

3.13 getNewSheetDynamicInfo 查询最新书单动态信息接口

3.13.1 接口描述

查询最新书单动态信息

3.13.2 最后修改信息

3.13.3 调用方

3.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

newSheetDynamicInfoList

Response

String

1

最新动态信息列表

NewSheetDynamicInfo

newSheetDynamicInfoList

String

0...N

最新动态信息

sheetId

NewSheetDynamicInfo

String

1

书单ID

msisdn

NewSheetDynamicInfo

String

1

阅读号

title

NewSheetDynamicInfo

String

1

书单标题

sheetDesc

NewSheetDynamicInfo

String

1

书单描述

shareNum

NewSheetDynamicInfo

String

1

书单分享次数

permission

NewSheetDynamicInfo

String

1

书单隐私状态(0:公开 1:仅自己可见)

status

NewSheetDynamicInfo

String

1

书单状态(0:正常;1:删除)

createtime

NewSheetDynamicInfo

String

1

书单创建时间

clickTimes

NewSheetDynamicInfo

String

1

书单点击次数

glorifiedTimes

NewSheetDynamicInfo

String

1

书单点赞次数

3.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.13.6 报文样例

请求方法

 
POST /portalapi/getNewSheetDynamicInfo

请求报文

 
<Request>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>24</totalCount>
    <newSheetDynamicInfoList>
        <NewSheetDynamicInfo>
            <sheetId>26</sheetId>
            <msisdn>18600000000</msisdn>
            <title>test</title>
            <sheetDesc>test</sheetDesc>
            <shareNum>260</shareNum>
            <permission>0</permission>
            <status>0</status>
            <createtime>2014-05-01</createtime>
            <clickTimes>100</clickTimes>
            <glorifiedTimes>50</glorifiedTimes>
        </NewSheetDynamicInfo>
    </newSheetDynamicInfoList>
</Response>
 

3.13.7 接口响应码

响应码

描述

11014

start为空

11015

start非法

11016

count为空

11017

count非法

2000

其它异常

3.14 getShareBookSheetsByUser 获取用户分享的书单列表接口

3.14.1 接口描述

根据手机号查询用户分享的所有书单信息

3.14.2 最后修改信息

3.14.3 调用方

3.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1分享时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetList

Response

List

0...1

分享的书单列表

BookSheetInfo

sheetList

BookSheetInfo

1...N

书单信息

sheetid

BookSheetInfo

String

1

书单Id

msisdn

BookSheetInfo

String

1

阅读号

title

BookSheetInfo

String

1

书单标题

sheetdesc

BookSheetInfo

String

0...1

书单描述

sharenum

BookSheetInfo

String

1

书单分享次数

booknum

BookSheetInfo

String

1

书单书目个数

clickTimes

BookSheetInfo

String

1

点击量

glorifiedTimes

BookSheetInfo

String

1

点赞量

permission

BookSheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

BookSheetInfo

String

1

书单状态 0:正常 1:删除

createtime

BookSheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

3.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.14.6 报文样例

请求方法

 
POST /portalapi/getShareBookSheetsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <sheetList>
        <BookSheetInfo>
            <sheetid>3000739</sheetid>
            <msisdn>15077870000</msisdn>
            <title>书单一</title>
            <sheetdesc>书单一的描述</sheetdesc>
            <sharenum>0</sharenum>
            <booknum>3</booknum>
            <clickTimes>100</clickTimes>
            <glorifiedTimes>100</glorifiedTimes>
            <permission>1</permission>
            <status>0</status>
            <createtime>20130930152040</createtime>
        </BookSheetInfo>
        <BookSheetInfo>
            <sheetid>3000738</sheetid>
            <msisdn>13588164850</msisdn>
            <title>书单二</title>
            <sheetdesc></sheetdesc>
            <sharenum>11</sharenum>
            <booknum>4</booknum>
            <permission>0</permission>
            <status>0</status>
            <createtime>20130930152050</createtime>
        </BookSheetInfo>
    </sheetList>
</Response>
 

3.14.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500514

隐私值为空

500518

隐私值非法

3.15 getSheetRankList 查询书单综合排行榜接口

3.15.1 接口描述

查询书单综合排行榜接口

3.15.2 最后修改信息

3.15.3 调用方

3.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

rankingType

Request

int

排行范围(0总榜,2周榜,3月榜)

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultTotal

Response

int

1

总记录数

bookSheetRankingList

Response

List

1

书单排行列表

bookSheetRankingInfo

bookSheetRankingList

propsTop

0...N

书单排行

sheetId

bookSheetRankingInfo

String

1

书单ID

rank

bookSheetRankingInfo

String

1

排名

score

bookSheetRankingInfo

String

1

综合分数

3.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.15.6 报文样例

请求方法

 
POST /portalapi/getSheetRankList

请求报文

 
<Request>
    <rankingType>1</rankingType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <resultTotal>5</resultTotal>
    <bookSheetRankingList>
        <bookSheetRankingInfo>
            <sheetId>1000</sheetId>
            <rank>20</rank>
            <score>100</score>
        </bookSheetRankingInfo>
    </bookSheetRankingList>
</Response>
 

3.15.7 接口响应码

响应码

描述

11012

排行范围为空

11013

排行范围非法

11014

start为空

11015

start非法

11016

count为空

11017

count非法

2000

其它异常

3.16 getSingleNumAboutBook 查询图书分享次数总和、加入书单总数、被打赏人次总数接口

3.16.1 接口描述

查询图书分享次数总和、加入书单总数、被打赏人次总数接口

3.16.2 最后修改信息

3.16.3 调用方

3.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookId

Request

String

1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sharedTotal

Response

int

1

图书被分享总数

joinedTotal

Response

int

1

图书被加入书单总数

rewardTotal

Response

int

1

图书被打赏总数

3.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.16.6 报文样例

请求方法

 
POST /portalapi/getSingleNumAboutBook

请求报文

 
<Request>
    <bookId></bookId>
</Request>
 

响应报文

  
<Response>
    <sharedTotal>5</sharedTotal>
    <joinedTotal>5</joinedTotal>
    <rewardTotal>5</rewardTotal>
</Response>
 

3.16.7 接口响应码

响应码

描述

10801

图书ID为空

10802

图书ID不合法

3.17 getUserVipInfo 查询会员基础信息接口

3.17.1 接口描述

查询会员基础信息接口

3.17.2 最后修改信息

3.17.3 调用方

3.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

vipLevelId

Response

int

1

会员等级

levelName

Response

String

1

会员等级名称

levelScore

Response

long

1

等级积分

vipScore

Response

long

1

消费积分累加总量

deVipScore

Response

long

1

消费积分扣减总量

vipL

Response

String

0...1

vip大图标

vipM

Response

String

0...1

vip中图标

vipS

Response

String

0...1

vip小图标

unVipL

Response

String

0...1

vip大图标

unVipM

Response

String

0...1

vip中图标

unVipS

Response

String

0...1

vip小图标

3.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.17.6 报文样例

请求方法

 
POST /portalapi/getUserVipInfo

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
</Request>
 

响应报文

  
<Response>
    <vipLevelId>3</vipLevelId>
    <levelName>3</levelName>
    <levelScore>999999</levelScore>
    <vipScore>999999</vipScore>
    <deVipScore>999999</deVipScore>
    <vipL>1.png</vipL>
    <vipM>2.png</vipM>
    <vipS>3.png</vipS>
    <unVipL>1.gif</unVipL>
    <unVipM>2.gif</unVipM>
    <unVipS>3.gif</unVipS>
</Response>
 

3.17.7 接口响应码

响应码

描述

4000

手机号为空

4001

手机号非法

3.18 glorifyBookSheet 书单点赞接口

3.18.1 接口描述

互动DB记录点赞次数.需出点赞话单(功能实现待确认)

3.18.2 最后修改信息

3.18.3 调用方

3.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetId

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.18.6 报文样例

请求方法

 
POST /portalapi/glorifyBookSheet

请求报文

 
<Request>
    <msisdn>18700000000</msisdn>
    <sheetId>1</sheetId>
</Request>
 

响应报文

  
<Response></Response>
 

3.18.7 接口响应码

响应码

描述

4000

手机号为空

4001

手机号非法

12000

书单ID为空

12001

书单ID非法

12002

书单不存在

12003

书单非公开

12004

书单已被删除

12005

不能赞自己的书单

12006

已点赞

2000

other

3.19 havReviewScoreProxy 判断用户是否有评分权限

3.19.1 接口描述

判断该阅读号的用户是否有这本书的评分权限

3.19.2 最后修改信息

3.19.3 调用方

3.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookId

Request

String

1

图书ID

isSerial

Request

int

1

图书是否连载,0为非连载,1为连载

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.19.6 报文样例

请求方法

 
POST /portalapi/havReviewScoreProxy

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <bookId>3526789</bookId>
    <isSerial>0</isSerial>
</Request>
 

响应报文

  
<Response></Response>
 

3.19.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

4504

图书ID为空

7008

图书ID超过最大长度

80084

连载字段非法

80081

无评分资格-不是会员且无图书粉丝值

80082

无评分权限-非连载书且已对该书评分过

80083

无评分权限-连载图书且该书已经评分过但是图书粉丝值没有增加

3.20 queryUsersDistance 查询周边用户距离信息

3.20.1 接口描述

查询周边用户距离信息

3.20.2 最后修改信息

3.20.3 调用方

3.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

userMsisdn

Request

String

1

用户阅读号

neibourMsisdn

Request

String

1

周边用户阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

distance

Response

double

1

两用户之间的距离

3.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.20.6 报文样例

请求方法

 
POST /portalapi/queryUsersDistance

请求报文

 
<Request>
    <userMsisdn>13890901234</userMsisdn>
    <neibourMsisdn>13878726354</neibourMsisdn>
</Request>
 

响应报文

  
<Response>
    <distance>1344.0</distance>
</Response>
 

3.20.7 接口响应码

响应码

描述

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

80088

用户的位置信息不存在

2000

程序异常

3.21 queryVisitedDetail 查询用户被访客访问明细

3.21.1 接口描述

查询用户被访客访问明细

3.21.2 最后修改信息

3.21.3 调用方

3.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdnVisited

Request

String

1

被访问人阅读号

start

Request

String

1

起始位置

count

Request

String

1

分页数据

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

queryVisitedDetailList

Response

List

1

用户被访客访问明细列表

visitedDetailInfo

queryVisitedDetailList

QueryVisitedDetailEntity

0...N

用户被访客访问明细

msisdnVisit

visitedDetailInfo

String

1

访问人阅读号

msisdnVisited

visitedDetailInfo

String

1

被访问人阅读号

visitBehavior

visitedDetailInfo

String

1

访问行为

distance

visitedDetailInfo

String

1

访问时距离被访问人的距离

bookID

visitedDetailInfo

String

1

图书ID

timeVisit

visitedDetailInfo

String

1

访问时间

3.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.21.6 报文样例

请求方法

 
POST /portalapi/queryVisitedDetail

请求报文

 
<Request>
    <msisdnVisited>13890901234</msisdnVisited>
    <start>1</start>
    <count>26</count>
</Request>
 

响应报文

  
<Response>
    <totalCount></totalCount>
    <queryVisitedDetailList>
        <visitedDetailInfo>
            <msisdnVisit>13827678797</msisdnVisit>
            <msisdnVisited>13827678797</msisdnVisited>
            <visitBehavior>1</visitBehavior>
            <distance>13827678797</distance>
            <bookID>13827678797</bookID>
            <timeVisit>20140606120208</timeVisit>
        </visitedDetailInfo>
    </queryVisitedDetailList>
</Response>
 

3.21.7 接口响应码

响应码

描述

30014

被访问人阅读号为空

30015

被访问人阅读号非法

30020

分页数据为空

30021

分页数据非法

30022

起始位置为空

30023

起始位置非法

2000

程序异常

3.22 queryVisitorData 查询访客访问数据

3.22.1 接口描述

查询访客访问数据

3.22.2 最后修改信息

3.22.3 调用方

3.22.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdnVisited

Request

String

1

被访问人阅读号

type

Request

String

1

请求类型(0:查询访问总数;1:清空用户访问总数)

响应消息体

字段名

父字段名

字段类型

出现次数

描述

numVisited

Response

String

1

访问数

3.22.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.22.6 报文样例

请求方法

 
POST /portalapi/queryVisitorData

请求报文

 
<Request>
    <msisdnVisited>13890901234</msisdnVisited>
    <type>0</type>
</Request>
 

响应报文

  
<Response>
    <numVisited>100</numVisited>
</Response>
 

3.22.7 接口响应码

响应码

描述

30014

被访问人阅读号为空

30015

被访问人阅读号非法

30024

类型为空

30025

类型非法

2000

程序异常

3.23 recordCreateSheetDynameic 记录创建书单动态接口

3.23.1 接口描述

当用户在创建书单成功时,系统将创建书单记录到好友动态信息列表中

3.23.2 最后修改信息

3.23.3 调用方

3.23.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetId

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

returnCode

Response

Integer

1

返回结果(1:成功;0:失败)

3.23.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.23.6 报文样例

请求方法

 
POST /portalapi/recordCreateSheetDynameic

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <sheetId>100146</sheetId>
</Request>
 

响应报文

  
<Response>
    <returnCode>0</returnCode>
</Response>
 

3.23.7 接口响应码

响应码

描述

11001

阅读号为空

11002

阅读号非法

11003

书单ID为空

11004

书单ID非法

2000

其它异常

3.24 recordNewSheetDynamic 记录最新书单动态接口

3.24.1 接口描述

记录最新书单动态接口

3.24.2 最后修改信息

3.24.3 调用方

3.24.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetId

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

returnCode

Response

Integer

1

返回结果(1:记录成功;0:失败)

3.24.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.24.6 报文样例

请求方法

 
POST /portalapi/recordNewSheetDynamic

请求报文

 
<Request>
    <msisdn>18600000000</msisdn>
    <sheetId>100146</sheetId>
</Request>
 

响应报文

  
<Response>
    <returnCode>0</returnCode>
</Response>
 

3.24.7 接口响应码

响应码

描述

11001

阅读号为空

11002

阅读号非法

11003

书单ID为空

11004

书单ID非法

2000

其它异常

3.25 recordVisitorBehaviorData 记录访客行为数据上报

3.25.1 接口描述

记录访客行为数据上报

3.25.2 最后修改信息

3.25.3 调用方

3.25.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdnVisit

Request

String

1

访问人阅读号

msisdnVisited

Request

String

1

被访问人阅读号

visitBehavior

Request

String

1

访问行为

distance

Request

String

0...1

访问时距离被访问人的距离

bookID

Request

String

0...1

图书ID

timeVisit

Request

String

1

访问时间

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.25.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.25.6 报文样例

请求方法

 
POST /portalapi/recordVisitorBehaviorData

请求报文

 
<Request>
    <msisdnVisit>13890901234</msisdnVisit>
    <msisdnVisited>13878726354</msisdnVisited>
    <visitBehavior>1</visitBehavior>
    <distance>531165837</distance>
    <bookID>1234567890123456789</bookID>
    <timeVisit>20140609121212</timeVisit>
</Request>
 

响应报文

  
<Response></Response>
 

3.25.7 接口响应码

响应码

描述

200

成功

30010

访问人阅读号为空

30011

访问人阅读号非法

30012

访问行为为空

30013

访问行为非法

30014

被访问人阅读号为空

30015

被访问人阅读号非法

30016

图书ID为空

30017

图书ID非法

2000

程序异常

3.26 searchUserByLBS 查询周边好友信息

3.26.1 接口描述

根据用户的当前位置查询周边好友信息

3.26.2 最后修改信息

3.26.3 调用方

3.26.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

longitude

Request

double

1

经度,范围-180180

latitude

Request

double

1

纬度,范围-9090

uploadTime

Request

String

1

上报坐标位置时间

start

Request

int

0..1

分页起始序号,缺省为1,小于1时取默认值1

count

Request

int

0..1

每次返回的条数,不传或传入的参数不大于0时默认取20

响应消息体

字段名

父字段名

字段类型

出现次数

描述

size

Response

int

1

返回的消息条数

userAroundList

Response

List

0...1

周围用户列表

userAround

userAroundList

UserAround

0...N

周围用户的信息

msisdn

userAround

String

1

阅读号

distance

userAround

double

1

与用户的距离,缺省单位为米

uploadTime

userAround

String

1

上次更新位置的时间

3.26.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.26.6 报文样例

请求方法

 
POST /portalapi/searchUserByLBS

请求报文

 
<Request>
    <msisdn>13890901234</msisdn>
    <longitude>108.4598</longitude>
    <latitude>26.1357</latitude>
    <uploadTime>20140531165837</uploadTime>
    <start>0</start>
    <count>20</count>
</Request>
 

响应报文

  
<Response>
    <size>23</size>
    <userAroundList>
        <userAround>
            <msisdn>13890901234</msisdn>
            <distance>376.6</distance>
            <uploadTime>20140531165837</uploadTime>
        </userAround>
    </userAroundList>
</Response>
 

3.26.7 接口响应码

响应码

描述

2000

程序异常

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

80086

经度值非法

80087

纬度值非法

3.27 uploadLocation 用户上传地理位置信息

3.27.1 接口描述

用户上传地理位置信息

3.27.2 最后修改信息

3.27.3 调用方

3.27.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

longitude

Request

double

1

经度

latitude

Request

double

1

纬度

uploadTime

Request

String

1

上报坐标位置时间

响应消息体

字段名

父字段名

字段类型

出现次数

描述

3.27.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

3.27.6 报文样例

请求方法

 
POST /portalapi/uploadLocation

请求报文

 
<Request>
    <msisdn>13890901234</msisdn>
    <longitude>26.1357</longitude>
    <latitude>108.4598</latitude>
    <uploadTime>20140531165837</uploadTime>
</Request>
 

响应报文

  
<Response></Response>
 

3.27.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

阅读号为空

4001

阅读号非法

4002

阅读号长度错误

80086

经度值非法

80087

纬度值非法

4103

上传坐标时间为空

4105

上传坐标时间格式非法

4 CMI15

4.1 addBooksToOneSheet 往单个书单添加多本图书

4.1.1 接口描述

多本图书加入单个书单

4.1.2 最后修改信息

4.1.3 调用方

4.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

msisdn

Request

String

1

阅读号

bookList

Request

List

1

图书id集合

string

bookList

String

1...100

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

successNum

Response

String

1

添加图书成功数量

errorNum

Response

String

1

添加图书失败数量

errorBookList

Response

List

0...1

添加失败图书id的集合

string

errorBookList

String

0...100

图书ID

4.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.1.6 报文样例

请求方法

 
POST /portalapi/addBooksToOneSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
    <bookList>
        <string>1000</string>
    </bookList>
</Request>
 

响应报文

  
<Response>
    <successNum></successNum>
    <errorNum></errorNum>
    <errorBookList>
        <string>1000</string>
    </errorBookList>
</Response>
 

4.1.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500530

图书ID为空

500513

书单图书超出最大限制

500511

添加图书异常

500516

书单ID格式错误

4.2 addBookToMultipleSheet 单本图书添加到多个书单

4.2.1 接口描述

单本图书添加到多个书单

4.2.2 最后修改信息

4.2.3 调用方

4.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookid

Request

String

1

图书ID

msisdn

Request

String

1

阅读号

bookSheetList

Request

List

1

书单id集合

string

bookSheetList

String

1...20

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

successNum

Response

String

1

添加图书成功数量

errorNum

Response

String

1

添加图书失败数量

errorBookSheetList

Response

List

0...1

添加失败书单ID的集合

string

errorBookSheetList

String

0...20

图书ID

4.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.2.6 报文样例

请求方法

 
POST /portalapi/addBookToMultipleSheet

请求报文

 
<Request>
    <bookid>1000</bookid>
    <msisdn>13712345678</msisdn>
    <bookSheetList>
        <string>1000</string>
    </bookSheetList>
</Request>
 

响应报文

  
<Response>
    <successNum></successNum>
    <errorNum></errorNum>
    <errorBookSheetList>
        <string>1000</string>
    </errorBookSheetList>
</Response>
 

4.2.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500530

图书ID为空

500531

书单ID超过限制

500511

添加图书异常

500516

书单ID格式错误

4.3 addContentReview 内容评论接口

4.3.1 接口描述

内容评论接口

4.3.2 最后修改信息

4.3.3 调用方

4.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

contentId

Request

long

1

被评论的内容ID

contentType

Request

String

1

被评论的内容类型(约定):50,书单;

comment

Request

String

1

评论内容。类型:VARCHAR2(2048)

publishType

Request

short

0...1

审核机制(不传默认为系统配制). 1:先发后审;2:先审后发

响应消息体

字段名

父字段名

字段类型

出现次数

描述

4.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.3.6 报文样例

请求方法

 
POST /portalapi/addContentReview

请求报文

 
<Request>
    <msisdn>1</msisdn>
    <contentId>1</contentId>
    <contentType>1</contentType>
    <comment>1</comment>
    <publishType>1</publishType>
</Request>
 

响应报文

  
<Response></Response>
 

4.3.7 接口响应码

响应码

描述

200

成功

-250

阅读号为null

-251

阅读号非法

-252

被评论的内容IDnull

-253

被评论的内容ID非法

-254

被评论的内容类型为null

-255

被评论的内容类型非法

-256

评论内容为null

-257

评论内容太长啦

-258

评论内容包含敏感词

-259

审核机制非法

-260

黑名单用户禁言

-263

频繁评论

4.4 bookSheetScore 书单评分

4.4.1 接口描述

书单评分

4.4.2 最后修改信息

4.4.3 调用方

4.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

Msisdn

Request

String

1

阅读号

sheetID

Request

String

1

书单ID

score

Request

String

1

书评分

响应消息体

字段名

父字段名

字段类型

出现次数

描述

4.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.4.6 报文样例

请求方法

 
POST /portalapi/bookSheetScore

请求报文

 
<Request>
    <Msisdn>13890901234</Msisdn>
    <sheetID>123</sheetID>
    <score>26</score>
</Request>
 

响应报文

  
<Response></Response>
 

4.4.7 接口响应码

响应码

描述

305401

阅读号为空

305402

阅读号非法

305403

书单ID为空

305404

书单ID非法

305406

书评分非法

305407

用户已评分

305408

书单ID不存在

200

入库成功

2000

程序异常

4.5 cancelCollectBookSheet 取消收藏

4.5.1 接口描述

取消收藏

4.5.2 最后修改信息

4.5.3 调用方

4.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

4.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.5.6 报文样例

请求方法

 
POST /portalapi/cancelCollectBookSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response></Response>
 

4.5.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500551

取消收藏异常

500516

书单ID格式错误

500549

该书单已经被取消收藏

500553

该收藏不存在

4.6 collectBookSheet 收藏书单

4.6.1 接口描述

收藏书单

4.6.2 最后修改信息

4.6.3 调用方

4.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

4.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.6.6 报文样例

请求方法

 
POST /portalapi/collectBookSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response></Response>
 

4.6.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500529

书单ID不存在

500550

收藏书单异常

500516

书单ID格式错误

500547

书单收藏超过限制

500548

该书单已经被收藏

4.7 createBookCatalog 添加书目接口

4.7.1 接口描述

添加书目接口

4.7.2 最后修改信息

4.7.3 调用方

4.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookid

Request

String

1

图书ID

sheetid

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

成功

4.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.7.6 报文样例

请求方法

 
POST /portalapi/createBookCatalog

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <bookid>114524</bookid>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

4.7.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID格式错误

500510

图书ID为空

500513

创建书目超出最大限制

500511

添加图书异常

500523

该书目已经存在

4.8 createBookSheet 用户创建书单

4.8.1 接口描述

用户创建书单

4.8.2 最后修改信息

4.8.3 调用方

4.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

title

Request

String

1

标题

msisdn

Request

String

1

阅读号

desc

Request

String

0...1

描述

bookid

Request

String

0...1

图书id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Response

String

1

书单id

4.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.8.6 报文样例

请求方法

 
POST /portalapi/createBookSheet

请求报文

 
<Request>
    <title>标题</title>
    <msisdn>13712345678</msisdn>
    <desc>描述</desc>
    <bookid>1000</bookid>
</Request>
 

响应报文

  
<Response>
    <sheetid>1</sheetid>
</Response>
 

4.8.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500502

书单标题为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500507

书单ID为空

500506

用户创建书单个数已达到上限

500511

创建书目异常

500513

创建书目超出最大限制

500523

该书目已经存在

4.9 getBookSheetCollectByMsisdn 查看用户收藏的书单

4.9.1 接口描述

查看用户收藏的书单

4.9.2 最后修改信息

4.9.3 调用方

4.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

bookSheetCollectList

Response

List

0...1

排行榜列表

bookSheetCollect

bookSheetCollectList

1...N

sheetid

bookSheetCollect

String

1

书单id

createDate

bookSheetCollect

String

1

收藏时间

4.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.9.6 报文样例

请求方法

 
POST /portalapi/getBookSheetCollectByMsisdn

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <start>1</start>
    <count>100</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>3</totalCount>
    <bookSheetCollectList>
        <bookSheetCollect>
            <sheetid>80</sheetid>
            <createDate>2014-07-09 15:12:49</createDate>
        </bookSheetCollect>
    </bookSheetCollectList>
</Response>
 

4.9.7 接口响应码

响应码

描述

2000

其他错误

12103

起始位置非法

12105

条数非法

12102

起始位置为空

12104

条数为空

500501

阅读号为空

500503

阅读号输入错误

4.10 getBookSheetInfo 获取书单信息详情接口

4.10.1 接口描述

根据书单ID查询书单详情信息

4.10.2 最后修改信息

4.10.3 调用方

4.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetInfo

Response

BookSheetInfo

0...1

书单信息

sheetid

sheetInfo

String

1

书单Id

msisdn

sheetInfo

String

1

阅读号

title

sheetInfo

String

1

书单标题

sheetdesc

sheetInfo

String

0...1

书单描述

sharenum

sheetInfo

String

1

书单分享次数

booknum

sheetInfo

String

1

书单书目个数

clickTimes

sheetInfo

String

1

点击量

glorifiedTimes

sheetInfo

String

1

点赞量

collectNum

sheetInfo

String

1

收藏量

permission

sheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

sheetInfo

String

1

书单状态 0:正常 1:删除

createtime

sheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

totalScore

sheetInfo

String

1

总评分

totalScoreNum

sheetInfo

String

1

总评分人数

4.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.10.6 报文样例

请求方法

 
POST /portalapi/getBookSheetInfo

请求报文

 
<Request>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <sheetInfo>
        <sheetid>3000739</sheetid>
        <msisdn>15077870000</msisdn>
        <title>书单一</title>
        <sheetdesc>书单一的描述</sheetdesc>
        <sharenum>0</sharenum>
        <booknum>3</booknum>
        <clickTimes>100</clickTimes>
        <glorifiedTimes>100</glorifiedTimes>
        <collectNum>100</collectNum>
        <permission>1</permission>
        <status>0</status>
        <createtime>20130930152040</createtime>
        <totalScore>2.1</totalScore>
        <totalScoreNum>2</totalScoreNum>
    </sheetInfo>
</Response>
 

4.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

500507

书单ID为空

500516

书单ID非法

4.11 getBookSheetInfoListByLabelID 根据标签id查询书单信息

4.11.1 接口描述

根据标签id查询书单信息

4.11.2 最后修改信息

4.11.3 调用方

4.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

labelID

Request

String

1

标签id

start

Request

String

1

起始位置

count

Request

String

1

条数

orderType

Request

String

0...1

排序 1 点击量、2 创建时间、3 评分、4 综合分(倒序),默认为综合分

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

int

1

总条数

bookSheetList

Response

List

0...1

书单信息

sheetid

bookSheetList

String

1

书单ID

4.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.11.6 报文样例

请求方法

 
POST /portalapi/getBookSheetInfoListByLabelID

请求报文

 
<Request>
    <labelID>1</labelID>
    <start>1</start>
    <count>5</count>
    <orderType></orderType>
</Request>
 

响应报文

  
<Response>
    <totalCount></totalCount>
    <bookSheetList>
        <sheetid></sheetid>
    </bookSheetList>
</Response>
 

4.11.7 接口响应码

响应码

描述

200

成功

2000

程序异常

12102

start为空

12103

start非法

12104

count为空

12105

count非法

500562

标签ID为空

500563

标签ID非法

500566

标签ID不存在

500571

排序参数非法

4.12 getBookSheetLabelBySheetId 查询书单标签接口

4.12.1 接口描述

查询书单标签接口

4.12.2 最后修改信息

4.12.3 调用方

4.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

labelList

Response

List

0...1

标签的集合

label

labelList

List

1...N

标签

labelID

label

String

1

标签ID

4.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.12.6 报文样例

请求方法

 
POST /portalapi/getBookSheetLabelBySheetId

请求报文

 
<Request>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <totalCount>3</totalCount>
    <labelList>
        <label>
            <labelID></labelID>
            <labelType></labelType>
            <labelName></labelName>
            <labelLevel></labelLevel>
        </label>
    </labelList>
</Response>
 

4.12.7 接口响应码

响应码

描述

2000

其他异常

500561

书单ID为空

500559

书单ID不存在

500560

书单ID格式错误

500000

查询标签异常

4.13 getBookSheetsByUser 获取用户书单列表接口

4.13.1 接口描述

根据手机号查询用户的所有书单信息

4.13.2 最后修改信息

4.13.3 调用方

4.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1创建时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

sheetList

Response

List

0...1

书单列表

BookSheetInfo

sheetList

BookSheetInfo

1...N

书单信息

sheetid

BookSheetInfo

String

1

书单Id

msisdn

BookSheetInfo

String

1

阅读号

title

BookSheetInfo

String

1

书单标题

sheetdesc

BookSheetInfo

String

0...1

书单描述

sharenum

BookSheetInfo

String

1

书单分享次数

booknum

BookSheetInfo

String

1

书单书目个数

clickTimes

BookSheetInfo

String

1

点击量

glorifiedTimes

BookSheetInfo

String

1

点赞量

collectNum

BookSheetInfo

String

1

收藏量

permission

BookSheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

BookSheetInfo

String

1

书单状态 0:正常 1:删除

createtime

BookSheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

totalScore

BookSheetInfo

String

1

总评分

totalScoreNum

BookSheetInfo

String

1

总评分人数

4.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.13.6 报文样例

请求方法

 
POST /portalapi/getBookSheetsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <sheetList>
        <BookSheetInfo>
            <sheetid>3000739</sheetid>
            <msisdn>15077870000</msisdn>
            <title>书单一</title>
            <sheetdesc>书单一的描述</sheetdesc>
            <sharenum>0</sharenum>
            <booknum>3</booknum>
            <clickTimes>100</clickTimes>
            <glorifiedTimes>100</glorifiedTimes>
            <collectNum>100</collectNum>
            <permission>1</permission>
            <status>0</status>
            <createtime>20130930152040</createtime>
            <totalScore>2.1</totalScore>
            <totalScoreNum>2</totalScoreNum>
        </BookSheetInfo>
    </sheetList>
</Response>
 

4.13.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500514

隐私值为空

500518

隐私值非法

4.14 getContentReview 查询内容评论接口

4.14.1 接口描述

查询内容评论接口

4.14.2 最后修改信息

4.14.3 调用方

4.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

reviewId

Request

long

1

评论编码

响应消息体

字段名

父字段名

字段类型

出现次数

描述

reviewInfo

Response

ReviewInfo

1...N

书单信息

reviewId

reviewInfo

Long

1

评论编码

floorNum

reviewInfo

Integer

1

楼层

msisdn

reviewInfo

String

1

阅读号

contentId

reviewInfo

String

1

被评论的内容ID

contentType

reviewInfo

String

1

被评论的内容类型

comment

reviewInfo

String

1

评论内容。类型:VARCHAR2(2048)

publishTime

reviewInfo

String

1

发布时间

4.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.14.6 报文样例

请求方法

 
POST /portalapi/getContentReview

请求报文

 
<Request>
    <reviewId>1</reviewId>
</Request>
 

响应报文

  
<Response>
    <reviewInfo>
        <reviewId>3002</reviewId>
        <floorNum>3002</floorNum>
        <msisdn>1</msisdn>
        <contentId>1</contentId>
        <contentType>1</contentType>
        <comment>1</comment>
        <publishTime>yyyyMMddHHmmss</publishTime>
    </reviewInfo>
</Response>
 

4.14.7 接口响应码

响应码

描述

-260

reviewIdnull

-261

reviewId非法

-264

评论不存在

4.15 getContentReviewCount 查询内容评论数量接口

4.15.1 接口描述

查询内容评论数量接口

4.15.2 最后修改信息

4.15.3 调用方

4.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

contentId

Request

long

1

被评论的内容ID

contentType

Request

String

1

被评论的内容类型

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

4.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.15.6 报文样例

请求方法

 
POST /portalapi/getContentReviewCount

请求报文

 
<Request>
    <contentId>1</contentId>
    <contentType>1</contentType>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
</Response>
 

4.15.7 接口响应码

响应码

描述

-252

contentIdnull

-253

contentId非法

-254

contentTypenull

-255

contentType非法

4.16 getContentReviewList 查询内容评论列表接口

4.16.1 接口描述

查询内容评论列表接口

4.16.2 最后修改信息

4.16.3 调用方

4.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

contentId

Request

long

1

被评论的内容ID

contentType

Request

String

1

被评论的内容类型

start

Request

int

1

分页编号

count

Request

int

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

reviewInfoList

Response

List

0...1

书单列表

reviewInfo

reviewInfoList

ReviewInfo

1...N

书单信息

reviewId

reviewInfo

Long

1

评论编码

floorNum

reviewInfo

Integer

1

楼层

msisdn

reviewInfo

String

1

阅读号

contentId

reviewInfo

String

1

被评论的内容ID

contentType

reviewInfo

String

1

被评论的内容类型

comment

reviewInfo

String

1

评论内容。类型:VARCHAR2(2048)

publishTime

reviewInfo

String

1

发布时间

4.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.16.6 报文样例

请求方法

 
POST /portalapi/getContentReviewList

请求报文

 
<Request>
    <contentId>1</contentId>
    <contentType>1</contentType>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <reviewInfoList>
        <reviewInfo>
            <reviewId>3002</reviewId>
            <floorNum>3002</floorNum>
            <msisdn>1</msisdn>
            <contentId>1</contentId>
            <contentType>1</contentType>
            <comment>1</comment>
            <publishTime>yyyyMMddHHmmss</publishTime>
        </reviewInfo>
    </reviewInfoList>
</Response>
 

4.16.7 接口响应码

响应码

描述

-252

contentIdnull

-253

contentId非法

-254

contentTypenull

-255

contentType非法

4003

start为空

4004

start非法

4005

count为空

4006

count非法

4.17 getNewSheetDynamicInfo 查询最新书单动态信息接口

4.17.1 接口描述

查询最新书单动态信息

4.17.2 最后修改信息

4.17.3 调用方

4.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

int

1

起始位置

count

Request

int

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

newSheetDynamicInfoList

Response

String

1

最新动态信息列表

NewSheetDynamicInfo

newSheetDynamicInfoList

String

0...N

最新动态信息

sheetId

NewSheetDynamicInfo

String

1

书单ID

msisdn

NewSheetDynamicInfo

String

1

阅读号

title

NewSheetDynamicInfo

String

1

书单标题

sheetDesc

NewSheetDynamicInfo

String

1

书单描述

shareNum

NewSheetDynamicInfo

String

1

书单分享次数

permission

NewSheetDynamicInfo

String

1

书单隐私状态(0:公开 1:仅自己可见)

status

NewSheetDynamicInfo

String

1

书单状态(0:正常;1:删除)

createtime

NewSheetDynamicInfo

String

1

书单创建时间

clickTimes

NewSheetDynamicInfo

String

1

书单点击次数

glorifiedTimes

NewSheetDynamicInfo

String

1

书单点赞次数

collectNum

NewSheetDynamicInfo

String

1

收藏量

totalScore

NewSheetDynamicInfo

String

1

总评分

totalScoreNum

NewSheetDynamicInfo

String

1

总评分人数

4.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.17.6 报文样例

请求方法

 
POST /portalapi/getNewSheetDynamicInfo

请求报文

 
<Request>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>24</totalCount>
    <newSheetDynamicInfoList>
        <NewSheetDynamicInfo>
            <sheetId>26</sheetId>
            <msisdn>18600000000</msisdn>
            <title>test</title>
            <sheetDesc>test</sheetDesc>
            <shareNum>260</shareNum>
            <permission>0</permission>
            <status>0</status>
            <createtime>2014-05-01</createtime>
            <clickTimes>100</clickTimes>
            <glorifiedTimes>50</glorifiedTimes>
            <collectNum>50</collectNum>
            <totalScore>2.1</totalScore>
            <totalScoreNum>2</totalScoreNum>
        </NewSheetDynamicInfo>
    </newSheetDynamicInfoList>
</Response>
 

4.17.7 接口响应码

响应码

描述

11014

start为空

11015

start非法

11016

count为空

11017

count非法

2000

其它异常

4.18 getSystemLabelByType 查询系统标签接口

4.18.1 接口描述

查询系统标签接口

4.18.2 最后修改信息

4.18.3 调用方

4.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

type

Request

String

1

标签查询类型 0:全部标签;1:一级标签;2:一级标签下二级标签;3:一级标签下的二级标签,包含一级标签

oneLabelId

Request

String

0...1

一级标签id(查询类型为23时,此参数必填)

响应消息体

字段名

父字段名

字段类型

出现次数

描述

labelList

Response

List

0...1

标签列表

label

labelList

labelID

label

String

1

标签ID

labelName

label

String

1

标签名称

labelLevel

label

String

1

标签分类 1:一级标签;2:二级标签;3:合集

oneLabelID

label

String

0...1

当是二级标签时对应的一级标签的id(一级标签时,此处为空)

oneLabelName

label

String

0...1

当是二级标签时对应的一级标签的名称(一级标签时,此处为空)

4.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.18.6 报文样例

请求方法

 
POST /portalapi/getSystemLabelByType

请求报文

 
<Request>
    <type>1</type>
    <oneLabelId></oneLabelId>
</Request>
 

响应报文

  
<Response>
    <labelList>
        <label>
            <labelID></labelID>
            <labelName></labelName>
            <labelLevel></labelLevel>
            <oneLabelID></oneLabelID>
            <oneLabelName></oneLabelName>
        </label>
    </labelList>
</Response>
 

4.18.7 接口响应码

响应码

描述

2000

其他异常

500000

一级标签为空

500555

标签类型为空

500556

标签类型非法

500557

一级标签非法

500558

一级标签不存在

4.19 getVipScoreDetail 获取会员积分或者消费明细

4.19.1 接口描述

获取会员积分或者消费明细

4.19.2 最后修改信息

4.19.3 调用方

4.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

type

Request

String

1

查询类型 1:等级明细;2:消费明细;

msisdn

Request

String

1

阅读号

start

Request

String

1

起始位置

count

Request

String

1

条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

detailList

Response

List

0...1

列表

scoreDetail

detailList

msisdn

scoreDetail

String

1

阅读号

eventType

scoreDetail

String

1

动作 扣减和消费动作

changedScore

scoreDetail

String

1

积分分数

changeTime

scoreDetail

String

0...1

时间

4.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.19.6 报文样例

请求方法

 
POST /portalapi/getVipScoreDetail

请求报文

 
<Request>
    <type>1</type>
    <msisdn>13712345678</msisdn>
    <start>1</start>
    <count>100</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>6</totalCount>
    <detailList>
        <scoreDetail>
            <msisdn></msisdn>
            <eventType></eventType>
            <changedScore></changedScore>
            <changeTime></changeTime>
        </scoreDetail>
    </detailList>
</Response>
 

4.19.7 接口响应码

响应码

描述

2000

其他异常

500600

阅读号为空

500601

阅读号非法

500602

起始位置为空

500603

起始位置非法

500604

条数为空

500605

条数非法

500606

查询类型为空

500607

查询类型非法

4.20 isCollected 查询书单是否被当前用户收藏接口

4.20.1 接口描述

查询书单是否被当前用户收藏信息

4.20.2 最后修改信息

4.20.3 调用方

4.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetId

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

status

Response

String

1

收藏书单标志位

4.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.20.6 报文样例

请求方法

 
POST /portalapi/isCollected

请求报文

 
<Request>
    <msisdn>15871359956</msisdn>
    <sheetId>100</sheetId>
</Request>
 

响应报文

  
<Response>
    <status>1</status>
</Response>
 

4.20.7 接口响应码

响应码

描述

500501

阅读号不能为空

500503

阅读号输入错误

500507

书单id不能为空

500516

书单id输入错误

500529

书单id不存在

500554

该用户没有收藏书单记录

2000

其他错误

4.21 modifyBookSheet 用户修改书单

4.21.1 接口描述

用户创建书单

4.21.2 最后修改信息

4.21.3 调用方

4.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

title

Request

String

1

标题

msisdn

Request

String

1

阅读号

desc

Request

String

0...1

描述

sheetid

Request

String

0...1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单修改成功

4.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.21.6 报文样例

请求方法

 
POST /portalapi/modifyBookSheet

请求报文

 
<Request>
    <title>标题</title>
    <msisdn>13712345678</msisdn>
    <desc>描述</desc>
    <sheetid>1000</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

4.21.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500502

书单标题为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500507

书单ID为空

500516

书单ID非法

500508

阅读号和书单ID不匹配,修改失败

600610

书单标题不能含有一级敏感词

600611

书单描述不能含有一级敏感词

4.22 modifyBookSheetTag 修改书单标签

4.22.1 接口描述

用户修改书单标签

4.22.2 最后修改信息

4.22.3 调用方

4.22.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookSheetId

Request

String

1

书单ID

labelList

Request

List

1

标签列表

string

labelList

String

0..1

标签ID,用户标签1(系统标签0

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单修改成功

4.22.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.22.6 报文样例

请求方法

 
POST /portalapi/modifyBookSheetTag

请求报文

 
<Request>
    <bookSheetId>156211</bookSheetId>
    <labelList>
        <string>1121212,1</string>
        <string>1121212,0</string>
    </labelList>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

4.22.7 接口响应码

响应码

描述

500507

书单ID为空

500516

书单ID非法

510004

书单ID不存在

510001

labelid与标签库不匹配

510002

label参数有误

510003

标签数量超过系统上限

2000

其他错误

4.23 queryBookSheetEachScoreNum 查询书单各分值下评分人数

4.23.1 接口描述

查询书单各分值下评分人数

4.23.2 最后修改信息

4.23.3 调用方

4.23.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetID

Request

String

1

书单ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

scoreNum0

Response

String

1

0分的人数

scoreNum2

Response

String

1

2分的人数

scoreNum4

Response

String

1

4分的人数

scoreNum6

Response

String

1

6分的人数

scoreNum8

Response

String

1

8分的人数

scoreNum10

Response

String

1

10分的人数

4.23.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.23.6 报文样例

请求方法

 
POST /portalapi/queryBookSheetEachScoreNum

请求报文

 
<Request>
    <sheetID>1389</sheetID>
</Request>
 

响应报文

  
<Response>
    <scoreNum0>344</scoreNum0>
    <scoreNum2>344</scoreNum2>
    <scoreNum4>344</scoreNum4>
    <scoreNum6>344</scoreNum6>
    <scoreNum8>344</scoreNum8>
    <scoreNum10>344</scoreNum10>
</Response>
 

4.23.7 接口响应码

响应码

描述

305403

书单ID为空

305404

书单ID非法

2000

程序异常

4.24 updateBookSheetLabelByLabelID 更新书单标签

4.24.1 接口描述

更细书单标签关联关系(这里只有删除操作),该接口只给manager使用

4.24.2 最后修改信息

4.24.3 调用方

4.24.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

labelID

Request

String

1

标签ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

4.24.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

4.24.6 报文样例

请求方法

 
POST /portalapi/updateBookSheetLabelByLabelID

请求报文

 
<Request>
    <labelID>1</labelID>
</Request>
 

响应报文

  
<Response></Response>
 

4.24.7 接口响应码

响应码

描述

2000

其他错误

500562

标签ID为空

500563

标签ID非法

5 CMI16

5.1 createBookSheet 创建书单接口

5.1.1 接口描述

用户创建书单

5.1.2 最后修改信息

5.1.3 调用方

5.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

title

Request

String

1

书单标题

msisdn

Request

String

1

阅读号

desc

Request

String

0...1

书单描述

bookid

Request

String

0...1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Response

String

1

书单id

5.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

5.1.6 报文样例

请求方法

 
POST /portalapi/createBookSheet

请求报文

 
<Request>
    <title>标题</title>
    <msisdn>13712345678</msisdn>
    <desc>描述</desc>
    <bookid>1000</bookid>
</Request>
 

响应报文

  
<Response>
    <sheetid>1</sheetid>
</Response>
 

5.1.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500502

书单标题为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500506

用户创建书单个数已达到上限

500507

书单ID为空

500511

创建书目异常

500513

创建书目超出最大限制

500523

该书目已经存在

600610

书单标题不能含有一级敏感词

600611

书单描述不能含有一级敏感词

5.2 getFanHundredRanking 根据bookid查询图书粉丝值前100

5.2.1 接口描述

根据bookid查询图书粉丝值前100

5.2.2 最后修改信息

5.2.3 调用方

5.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookid

Request

String

0...1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

bookfansList

Response

List

0...1

书单列表

BookFansInfo

bookfansList

BookFansInfo

1...N

用户图书粉丝值信息

msisdn

BookFansInfo

String

1

用户名

userName

BookFansInfo

String

1

用户昵称

fansScore

BookFansInfo

long

1

用户粉丝值

rank

BookFansInfo

Integer

1

排名

5.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

5.2.6 报文样例

请求方法

 
POST /portalapi/getFanHundredRanking

请求报文

 
<Request>
    <bookid>1000</bookid>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <bookfansList>
        <BookFansInfo>
            <msisdn>1</msisdn>
            <userName>1</userName>
            <fansScore>1</fansScore>
            <rank>1</rank>
        </BookFansInfo>
    </bookfansList>
</Response>
 

5.2.7 接口响应码

响应码

描述

2000

其他错误

4504

图书ID为空

7008

图书ID超过最大长度

5.3 modifyBookSheet 修改书单

5.3.1 接口描述

修改书单

5.3.2 最后修改信息

5.3.3 调用方

5.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

title

Request

String

1

书单标题

desc

Request

String

0...1

书单标题

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

5.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

5.3.6 报文样例

请求方法

 
POST /portalapi/modifyBookSheet

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <title>书单一</title>
    <desc>书单一的描述</desc>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response></Response>
 

5.3.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号不能为空

500502

书单标题不能为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500507

书单ID不能为空

500508

修改书单错误,手机号和书单id不匹配

500516

书单ID格式错误

600610

书单标题不能含有一级敏感词

600611

书单描述不能含有一级敏感词

6 oscache

6.1 getAllLayerTemplateNodeList 根据节点ID查询布局模板页面列表接口

6.1.1 接口描述

根据节点ID查询布局模板页面列表。在snswap缓存中使用

6.1.2 最后修改信息

6.1.3 调用方

6.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

layerId

Request

String

1

节点Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

layerTemplateNodeList

Response

List

0...1

模板页面信息列表

LayerTemplateNodeInfo

layerTemplateNodeList

LayerTemplateNodeInfo

1...N

模板页面信息

layerId

LayerTemplateNodeInfo

List

1

模板Id

parentId

LayerTemplateNodeInfo

List

1

父模板Id

layerName

LayerTemplateNodeInfo

List

1

模板名称

templateId

LayerTemplateNodeInfo

List

1

页面类型Id

fileName

LayerTemplateNodeInfo

List

0...1

文件名

realPath

LayerTemplateNodeInfo

List

0...1

文件路径

6.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.1.6 报文样例

请求方法

 
POST /portalapi/getAllLayerTemplateNodeList

请求报文

 
<Request>
    <layerId>6</layerId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <layerTemplateNodeList>
        <LayerTemplateNodeInfo>
            <layerId>6</layerId>
            <parentId>0</parentId>
            <layerName>直播间</layerName>
            <templateId>3</templateId>
            <fileName>historydetail.jsp</fileName>
            <realPath>/wap/p/live/</realPath>
        </LayerTemplateNodeInfo>
        <LayerTemplateNodeInfo>
            <layerId>112</layerId>
            <parentId>6</parentId>
            <layerName>韩寒-书友见面会</layerName>
            <templateId>0</templateId>
        </LayerTemplateNodeInfo>
    </layerTemplateNodeList>
</Response>
 

6.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4140

模板Id为空

4141

模板Id为非数字

6.2 getAllPtlPageList 分页查询所有页面列表接口

6.2.1 接口描述

分页查询所有页面列表。在snswap缓存中使用

6.2.2 最后修改信息

6.2.3 调用方

6.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

fileName

Request

String

0

垃圾字段

realPath

Request

String

0

垃圾字段

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

ptlPageList

Response

List

0...1

页面列表

PtlPageInfo

ptlPageList

PtlPageInfo

1...N

页面信息

pageId

PtlPageInfo

String

1

页面Id

pageType

PtlPageInfo

String

1

页面类型 0:未关联地域页面、1:首页、2:详情页、3:阅读页、4:预置页面、5:推荐页面、6:专区列表页、7:书讯阅读页

state

PtlPageInfo

String

1

状态 1:保存(未测试)、2:测试(未发布)、3:完全发布、4:部分发布、5:定时发布、6:已删除

layerId

PtlPageInfo

String

1

发布节点Id

createTime

PtlPageInfo

String

1

创建时间

lastEditTime

PtlPageInfo

String

1

最后编辑时间

creator

PtlPageInfo

String

1

创建人

lastEditOperator

PtlPageInfo

String

1

最后修改人

pageName

PtlPageInfo

String

1

页面名称

fileName

PtlPageInfo

String

1

文件名

realPath

PtlPageInfo

String

1

映射的wap目录

title

PtlPageInfo

String

1

WAP 页面显示title

templateTypeId

PtlPageInfo

String

1

模板Id

timerReleasea

PtlPageInfo

String

0...1

定时发布时间

descriptions

PtlPageInfo

String

0...1

描述

6.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.2.6 报文样例

请求方法

 
POST /portalapi/getAllPtlPageList

请求报文

 
<Request>
    <fileName></fileName>
    <realPath></realPath>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>562</totalRecordCount>
    <ptlPageList>
        <PtlPageInfo>
            <pageId>112</pageId>
            <pageType>0</pageType>
            <state>3</state>
            <layerId>3</layerId>
            <createTime>2010-12-14 14:30:45.0</createTime>
            <lastEditTime>2012-05-17 17:01:23.0</lastEditTime>
            <creator>cuijian</creator>
            <lastEditOperator>zhengshuangxi</lastEditOperator>
            <pageName>有奖问答-问答说明</pageName>
            <fileName>wdsm.jsp</fileName>
            <realPath>/wap/p/qanswer/</realPath>
            <title>有奖问答-问答说明</title>
            <templateTypeId>0</templateTypeId>
            <timerReleasea></timerReleasea>
            <descriptions></descriptions>
        </PtlPageInfo>
        <PtlPageInfo>
            <pageId>89</pageId>
            <pageType>0</pageType>
            <state>3</state>
            <layerId>4</layerId>
            <createTime>2010-12-10 00:23:39.0</createTime>
            <lastEditTime>2012-03-29 14:56:15.0</lastEditTime>
            <creator>admin</creator>
            <lastEditOperator>zhangp</lastEditOperator>
            <pageName>互帮互助-在线提问</pageName>
            <fileName>question.jsp</fileName>
            <realPath>/wap/p/help/</realPath>
            <title>互帮互助-在线提问</title>
            <templateTypeId>0</templateTypeId>
        </PtlPageInfo>
    </ptlPageList>
</Response>
 

6.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

6.3 getCircleLabelContentList 查询轮循标签内容列表接口

6.3.1 接口描述

查询轮循标签内容列表。在snswap缓存中使用

6.3.2 最后修改信息

6.3.3 调用方

6.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

strActiveId

Request

String

1

直播间Id/用户调查模板Id/有奖问答模板Id,以逗号分隔

modelId

Request

String

1

查询类型,6:直播间,9:用户调查,其他:有奖问答

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

circleLabelContentList

Response

List

1

轮循标签内容列表

CircleLabelContentInfo

circleLabelContentList

CircleLabelContentInfo

0...N

轮循标签内容信息

activeid

CircleLabelContentInfo

String

1

直播间Id/用户调查模板Id/有奖问答模板Id

layerid

CircleLabelContentInfo

String

1

布局Id

modelid

CircleLabelContentInfo

String

1

查询类型,6:直播间,9:用户调查,3:有奖问答

title

CircleLabelContentInfo

String

1

标题

begintime

CircleLabelContentInfo

String

1

开始时间

endtime

CircleLabelContentInfo

String

1

结束时间

roomState

CircleLabelContentInfo

String

0...1

直播间状态

hostname

CircleLabelContentInfo

String

0...1

主持人名

guestname

CircleLabelContentInfo

String

0...1

嘉宾名

6.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.3.6 报文样例

请求方法

 
POST /portalapi/getCircleLabelContentList

请求报文

 
<Request>
    <strActiveId>101,102</strActiveId>
    <modelId>6</modelId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <circleLabelContentList>
        <CircleLabelContentInfo>
            <activeid>101</activeid>
            <layerid>297</layerid>
            <modelid>6</modelid>
            <title>百家讲坛讲师趣读《史记》</title>
            <begintime>2011-11-26 14:30:00.0</begintime>
            <endtime>2011-11-26 16:30:00.0</endtime>
            <roomState>历史回顾</roomState>
            <hostname>蓝雨 </hostname>
            <guestname>王立群 </guestname>
        </CircleLabelContentInfo>
        <CircleLabelContentInfo>
            <activeid>102</activeid>
            <layerid>316</layerid>
            <modelid>6</modelid>
            <title>唐浚:细说《男人帮》恋爱法则</title>
            <begintime>2011-11-22 15:00:00.0</begintime>
            <endtime>2011-11-22 17:00:00.0</endtime>
            <roomState>历史回顾</roomState>
            <hostname>蓝雨 </hostname>
            <guestname>唐浚 </guestname>
        </CircleLabelContentInfo>
    </circleLabelContentList>
</Response>
 

6.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4142

strActiveId为空

6.4 getPageCircleLabelById 根据页面标签ID查询轮循标签内容接口

6.4.1 接口描述

根据页面标签ID查询轮循标签内容。在变更通知中使用

6.4.2 最后修改信息

6.4.3 调用方

6.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

pageLableId

Request

String

1

页面标签Id,垃圾字段

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

pageCircleLabelList

Response

List

1

轮循标签列表

PageCircleLabelInfo

pageCircleLabelList

PageCircleLabelInfo

0...N

轮循标签信息

pageLabelId

PageCircleLabelInfo

String

1

标签Id

paramKey

PageCircleLabelInfo

String

1

标签参数key

paramValue

PageCircleLabelInfo

String

1

标签参数value

6.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.4.6 报文样例

请求方法

 
POST /portalapi/getPageCircleLabelById

请求报文

 
<Request>
    <pageLableId>14530</pageLableId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <pageCircleLabelList>
        <PageCircleLabelInfo>
            <pageLabelId>14530</pageLabelId>
            <paramKey>cycle_content</paramKey>
            <paramValue>6:102:35,6:103:36,6:155:48,6:114:43,6:134:39,6:152:24,6:115:45,6:135:46,6:133:34,</paramValue>
        </PageCircleLabelInfo>
    </pageCircleLabelList>
</Response>
 

6.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4142

标签Id为空

4143

标签Id非数字

6.5 getPageCircleLabelList 分页查询所有有效的轮循标签内容接口

6.5.1 接口描述

分页查询所有有效的轮循标签内容。在snswap缓存中使用

6.5.2 最后修改信息

6.5.3 调用方

6.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

pageLableId

Request

String

0

页面标签Id,垃圾字段

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

pageCircleLabelList

Response

List

1

轮循标签列表

PageCircleLabelInfo

pageCircleLabelList

PageCircleLabelInfo

0...N

轮循标签信息

pageLabelId

PageCircleLabelInfo

String

1

标签Id

paramKey

PageCircleLabelInfo

String

1

标签参数key

paramValue

PageCircleLabelInfo

String

1

标签参数value

6.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.5.6 报文样例

请求方法

 
POST /portalapi/getPageCircleLabelList

请求报文

 
<Request>
    <pageLableId></pageLableId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>29</totalRecordCount>
    <pageCircleLabelList>
        <PageCircleLabelInfo>
            <pageLabelId>14530</pageLabelId>
            <paramKey>cycle_content</paramKey>
            <paramValue>6:102:35,6:103:36,6:155:48,6:114:43,6:134:39,6:152:24,6:115:45,6:135:46,6:133:34,</paramValue>
        </PageCircleLabelInfo>
        <PageCircleLabelInfo>
            <pageLabelId>16966</pageLabelId>
            <paramKey>cycle_content</paramKey>
            <paramValue>6:157:54,6:156:51,6:154:37,6:115:45,6:134:39,</paramValue>
        </PageCircleLabelInfo>
    </pageCircleLabelList>
</Response>
 

6.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

6.6 getPtlPageByFileName 根据文件名查询页面信息接口

6.6.1 接口描述

根据文件名查询页面信息。在snswap缓存中使用

6.6.2 最后修改信息

6.6.3 调用方

6.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

fileName

Request

String

1

文件名

realPath

Request

String

1

映射的wap目录

start

Request

String

0

分页编号,垃圾字段

count

Request

String

0

分页长度,垃圾字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

ptlPageList

Response

List

0...1

页面列表

PtlPageInfo

ptlPageList

PtlPageInfo

1

页面信息

pageId

PtlPageInfo

String

1

页面Id

pageType

PtlPageInfo

String

1

页面类型 0:未关联地域页面、1:首页、2:详情页、3:阅读页、4:预置页面、5:推荐页面、6:专区列表页、7:书讯阅读页

state

PtlPageInfo

String

1

状态 1:保存(未测试)、2:测试(未发布)、3:完全发布、4:部分发布、5:定时发布、6:已删除

layerId

PtlPageInfo

String

1

发布节点Id

createTime

PtlPageInfo

String

1

创建时间

lastEditTime

PtlPageInfo

String

1

最后编辑时间

creator

PtlPageInfo

String

1

创建人

lastEditOperator

PtlPageInfo

String

1

最后修改人

pageName

PtlPageInfo

String

1

页面名称

fileName

PtlPageInfo

String

1

文件名

realPath

PtlPageInfo

String

1

映射的wap目录

title

PtlPageInfo

String

1

WAP 页面显示title

templateTypeId

PtlPageInfo

String

1

模板Id

timerReleasea

PtlPageInfo

String

0...1

定时发布时间

descriptions

PtlPageInfo

String

0...1

描述

6.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.6.6 报文样例

请求方法

 
POST /portalapi/getPtlPageByFileName

请求报文

 
<Request>
    <fileName>wdsm.jsp</fileName>
    <realPath>/wap/p/qanswer/</realPath>
    <start></start>
    <count></count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <ptlPageList>
        <PtlPageInfo>
            <pageId>112</pageId>
            <pageType>0</pageType>
            <state>3</state>
            <layerId>3</layerId>
            <createTime>2010-12-14 14:30:45.0</createTime>
            <lastEditTime>2012-05-17 17:01:23.0</lastEditTime>
            <creator>cuijian</creator>
            <lastEditOperator>zhengshuangxi</lastEditOperator>
            <pageName>有奖问答-问答说明</pageName>
            <fileName>wdsm.jsp</fileName>
            <realPath>/wap/p/qanswer/</realPath>
            <title>有奖问答-问答说明</title>
            <templateTypeId>0</templateTypeId>
            <timerReleasea></timerReleasea>
            <descriptions></descriptions>
        </PtlPageInfo>
    </ptlPageList>
</Response>
 

6.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4144

映射的wap目录为空

4145

文件名为空

6.7 getSnsParameter 获取门户参数接口

6.7.1 接口描述

获取门户参数。在snswap缓存中使用

6.7.2 最后修改信息

6.7.3 调用方

6.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

name

Request

String

1

门户参数名

响应消息体

字段名

父字段名

字段类型

出现次数

描述

parameter

Response

parameter

1

门户参数信息

name

parameter

parameter

1

参数名

value

parameter

parameter

1

参数值

describe

parameter

parameter

1

参数描述

6.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.7.6 报文样例

请求方法

 
POST /portalapi/getSnsParameter

请求报文

 
<Request>
    <name>interaction_www_roomdetail</name>
</Request>
 

响应报文

  
<Response>
    <parameter>
        <name>interaction_www_roomdetail</name>
        <value>http://read.10086.cn/readChina/toChatRoom?rid=</value>
        <describe>www直播间详情页URL</describe>
    </parameter>
</Response>
 

6.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

2004

门户参数请求参数为空

2005

门户参数不存在

6.8 getSystemSetting 分页查询所有系统参数接口

6.8.1 接口描述

分页查询所有系统参数。在snswap缓存中使用

6.8.2 最后修改信息

6.8.3 调用方

6.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

basicSettingList

Response

List

0...1

系统参数列表

BasicSettingInfo

basicSettingList

BasicSettingInfo

1...N

系统参数列表

variable

BasicSettingInfo

String

1

value

BasicSettingInfo

String

1

6.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.8.6 报文样例

请求方法

 
POST /portalapi/getSystemSetting

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>138</totalRecordCount>
    <basicSettingList>
        <BasicSettingInfo>
            <variable>live_imagepercent</variable>
            <value>100,50,,,</value>
        </BasicSettingInfo>
        <BasicSettingInfo>
            <variable>platform_photopath</variable>
            <value>/img1,/img2,/img3,/img4,/img5</value>
        </BasicSettingInfo>
    </basicSettingList>
</Response>
 

6.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

6.9 getUserAreaByMobile 获取手机号码段区域接口

6.9.1 接口描述

获取手机号码段区域。在很多标签和snswap缓存中使用

6.9.2 最后修改信息

6.9.3 调用方

6.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

provinceCityNumsegmentInfo

Response

provinceCityNumsegmentInfo

1

号码段信息

numsegment

provinceCityNumsegmentInfo

String

0...1

手机号

provinceid

provinceCityNumsegmentInfo

String

0...1

Id

cityid

provinceCityNumsegmentInfo

String

0...1

Id

cityName

provinceCityNumsegmentInfo

String

0...1

市名称

provinceName

provinceCityNumsegmentInfo

String

0...1

省名称

6.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

6.9.6 报文样例

请求方法

 
POST /portalapi/getUserAreaByMobile

请求报文

 
<Request>
    <mobile>15077870000</mobile>
</Request>
 

响应报文

  
<Response>
    <provinceCityNumsegmentInfo>
        <numsegment>1507787</numsegment>
        <provinceid>250</provinceid>
        <cityid>25</cityid>
        <cityName>南京</cityName>
        <provinceName>江苏</provinceName>
    </provinceCityNumsegmentInfo>
</Response>
 

6.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

7 书评人等级体系

7.1 getBookClassRank 获取书评分类排行榜列表

7.1.1 接口描述

获取书评分类排行榜列表

7.1.2 最后修改信息

7.1.3 调用方

7.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookclassid

Request

String

1

图书分类id

start

Request

int

1

起始页码

count

Request

int

1

页面条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

Integer

0..1

总记录数

bookClassRankInfoLst

Response

List

0...1

图书分类排行榜列表

BookClassRankInfo

bookClassRankInfoLst

BookClassRankInfo

0...N

图书分类信息

bookclassid

BookClassRankInfo

int

0...1

图书分类ID

msisdn

BookClassRankInfo

int

0...1

手机号码

score

BookClassRankInfo

int

0...1

评分数

date

BookClassRankInfo

date

0...1

统计时间

7.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.1.6 报文样例

请求方法

 
POST /portalapi/getBookClassRank

请求报文

 
<Request>
    <bookclassid>30</bookclassid>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>2</total>
    <bookClassRankInfoLst>
        <BookClassRankInfo>
            <bookclassid>30</bookclassid>
            <msisdn>13588164855</msisdn>
            <score>50</score>
            <date>2014-01-13</date>
        </BookClassRankInfo>
        <BookClassRankInfo>
            <bookclassid>30</bookclassid>
            <msisdn>13588164850</msisdn>
            <score>30</score>
            <date>2014-01-10</date>
        </BookClassRankInfo>
    </bookClassRankInfoLst>
</Response>
 

7.1.7 接口响应码

响应码

描述

200

成功

6001

图书分类ID不能为空

6002

图书分类ID为非整数

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非整数

7.2 getBookReviewRank 获取书评图书排行榜列表

7.2.1 接口描述

获取书评图书排行榜列表

7.2.2 最后修改信息

7.2.3 调用方

7.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookId

Request

String

1

图书id

start

Request

int

1

起始页码

count

Request

int

1

页面条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

Integer

0..1

总记录数

BookReviewList

Response

List

0...1

图书排行榜列表

BookReviewInfo

BookReviewList

BookReviewInfo

0...N

图书信息

bookid

BookReviewInfo

int

0...1

图书ID

msisdn

BookReviewInfo

int

0...1

手机号码

score

BookReviewInfo

int

0...1

评分数

date

BookReviewInfo

String

0...1

统计时间

7.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.2.6 报文样例

请求方法

 
POST /portalapi/getBookReviewRank

请求报文

 
<Request>
    <bookId>5</bookId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <BookReviewList>
        <BookReviewInfo>
            <bookid>5</bookid>
            <msisdn>13588164855</msisdn>
            <score>50</score>
            <date>20140108000000</date>
        </BookReviewInfo>
        <BookReviewInfo>
            <bookid>5</bookid>
            <msisdn>13588164850</msisdn>
            <score>17</score>
            <date>20140108000000</date>
        </BookReviewInfo>
    </BookReviewList>
</Response>
 

7.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4504

图书iD为空

7007

图书ID非数字

7008

图书ID超过最大长度

7.3 getBookReviewInfoByMsisdn 根据用户的阅读号得到用户用户的书评人的得分和等级

7.3.1 接口描述

根据阅读号,查询用户的书评人的得分和等级

7.3.2 最后修改信息

7.3.3 调用方

7.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

levelId

Response

String

1

书评人等级ID

score

Response

String

1

用户的书评人得分

7.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.3.6 报文样例

请求方法

 
POST /portalapi/getBookReviewInfoByMsisdn

请求报文

 
<Request>
    <msisdn>18672316387</msisdn>
</Request>
 

响应报文

  
<Response>
    <levelId>1</levelId>
    <score>100</score>
</Response>
 

7.3.7 接口响应码

响应码

描述

500337

阅读号为空

500338

阅读号非法

2000

程序异常

7.4 getBookReviewLevelMap 获取书评人等级信息列表接口

7.4.1 接口描述

根据查询范围,查询所书评人等级信息列表,snsServer缓存中使用

7.4.2 最后修改信息

7.4.3 调用方

7.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

BookReviewLevelMap

Response

Map

1

书评人等级信息列表

Entry

BookReviewLevelMap

Entry

0...N

书评人等级信息Map中放的对象

String

Entry

String

1

key

BookReviewLevel

Entry

BookReviewLevel

value

levelId

BookReviewLevel

String

1

书评人等级ID

levelName

BookReviewLevel

String

1

书评人等级名称

botherScore

BookReviewLevel

String

1

书评人等级上限分

lowerScore

BookReviewLevel

String

1

书评人等级下限分

award

BookReviewLevel

String

1

书评人升级奖励

salary

BookReviewLevel

String

1

书评人等级工资

weight

BookReviewLevel

String

1

书评人权重

logoUrl16

BookReviewLevel

String

1

书评人等级16*16图片

logoUrl24

BookReviewLevel

String

1

书评人等级24*24图片

logoUrl32

BookReviewLevel

String

1

书评人等级32*32图片

7.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.4.6 报文样例

请求方法

 
POST /portalapi/getBookReviewLevelMap

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <BookReviewLevelMap>
        <Entry>
            <String> 1</String>
            <BookReviewLevel>
                <levelId>1</levelId>
                <levelName>皇冠</levelName>
                <botherScore>100</botherScore>
                <lowerScore>10</lowerScore>
                <award>100</award>
                <salary>100</salary>
                <weight>5</weight>
                <logoUrl16>
                                      images/reviewlevelogo/s/1_20140113150110/my.jpg
                                  </logoUrl16>
                <logoUrl24>
                                      images/reviewlevelogo/m/1_20140113150110/my.jpg
                                  </logoUrl24>
                <logoUrl32>
                                      images/reviewlevelogo/l/1_20140113150110/my.jpg
                                  </logoUrl32>
            </BookReviewLevel>
        </Entry>
    </BookReviewLevelMap>
</Response>
 

7.4.7 接口响应码

响应码

描述

500528

书评人等级信息列表为空

2000

程序异常

7.5 getBookReviewRank 获取书评图书排行榜列表

7.5.1 接口描述

获取书评图书排行榜列表

7.5.2 最后修改信息

7.5.3 调用方

7.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookId

Request

String

1

图书id

start

Request

int

1

起始页码

count

Request

int

1

页面条数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

Integer

0..1

总记录数

BookReviewList

Response

List

0...1

图书排行榜列表

BookReviewInfo

BookReviewList

BookReviewInfo

0...N

图书信息

bookid

BookReviewInfo

int

0...1

图书ID

msisdn

BookReviewInfo

int

0...1

手机号码

score

BookReviewInfo

int

0...1

评分数

date

BookReviewInfo

Date

0...1

统计时间

7.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.5.6 报文样例

请求方法

 
POST /portalapi/getBookReviewRank

请求报文

 
<Request>
    <bookId>5</bookId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <BookReviewList>
        <BookReviewInfo>
            <bookid>5</bookid>
            <msisdn>13588164855</msisdn>
            <score>50</score>
            <date>2014-01-08</date>
        </BookReviewInfo>
        <BookReviewInfo>
            <bookid>5</bookid>
            <msisdn>13588164850</msisdn>
            <score>17</score>
            <date>20140108000000</date>
        </BookReviewInfo>
    </BookReviewList>
</Response>
 

7.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4504

图书iD为空

7008

图书ID超过最大长度

7.6 getBookSheetShareRankByBookId 查询单本图书书单分享排行榜

7.6.1 接口描述

查询单本图书书单分享排行榜

7.6.2 最后修改信息

7.6.3 调用方

7.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

rankType

Request

String

1

榜单类型:0总榜,1,日榜,2,周榜,3月榜

rankStart

Request

String

1

查询起始位置

rankCount

Request

String

1

查询结束位置

bookid

Request

String

0...1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

ShareBookSheetList

Response

List

0...1

书单列表

ShareBookSheet

ShareBookSheetList

ShareBookSheet

1...N

分享书单信息

sheetId

ShareBookSheet

String

1

书单id

shareNum

ShareBookSheet

int

1

分享次数

creatTime

ShareBookSheet

String

1

创建时间

rankTop

ShareBookSheet

int

1

排名

7.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.6.6 报文样例

请求方法

 
POST /portalapi/getBookSheetShareRankByBookId

请求报文

 
<Request>
    <rankType>1</rankType>
    <rankStart>1</rankStart>
    <rankCount>10</rankCount>
    <bookid>1000</bookid>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <ShareBookSheetList>
        <ShareBookSheet>
            <sheetId>1</sheetId>
            <shareNum>1</shareNum>
            <creatTime>1</creatTime>
            <rankTop>1</rankTop>
        </ShareBookSheet>
    </ShareBookSheetList>
</Response>
 

7.6.7 接口响应码

响应码

描述

2000

其他错误

500527

图书ID为空

500524

书单排名类型为空

500523

排行榜类型不存在

500525

排行榜分页开始位置错误

500526

排行榜分页条数错误

7.7 getSalaryRequest 书评人等级工资领取

7.7.1 接口描述

书评人等级工资领取

7.7.2 最后修改信息

7.7.3 调用方

7.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

int

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultCode

Response

Integer

1

返回码

7.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.7.6 报文样例

请求方法

 
POST /portalapi/getSalaryRequest

请求报文

 
<Request>
    <msisdn>18771098878</msisdn>
</Request>
 

响应报文

  
<Response>
    <resultCode>200</resultCode>
</Response>
 

7.7.7 接口响应码

响应码

描述

200

成功

500337

阅读号为空

500338

阅读号非法

7000

调用平台接口生产书券失败

7001

评分表中此书评人信息为空

7002

书评人已领取工资

7003

书评人可领取工资为0

7.8 UpdateBookReviewerScore 顶驳书评分增减接口

7.8.1 接口描述

顶驳书评分增减

7.8.2 最后修改信息

7.8.3 调用方

7.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

int

1

顶驳人阅读号

optType

Request

int

1

顶驳操作码

pid

Request

int

1

帖子ID

authorMsisdn

Request

int

1

帖子作者阅读号

bookId

Request

int

1

帖子所在的图书ID

bookClassId

Request

int

1

帖子所在的图书分类ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultCode

Response

Integer

1

返回码

7.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

7.8.6 报文样例

请求方法

 
POST /portalapi/updateBookReviewerScore

请求报文

 
<Request>
    <msisdn>18671316386</msisdn>
    <optType>0</optType>
    <pid>8081</pid>
    <authorMsisdn>80891010101</authorMsisdn>
    <bookId>31</bookId>
    <bookClassId>19</bookClassId>
</Request>
 

响应报文

  
<Response>
    <resultCode>200</resultCode>
</Response>
 

7.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

阅读号为空

4001

阅读号非数字

4002

阅读号长度错误

7004

帖子作者为游客

7005

顶驳操作字符串非法

4090

帖子ID为空

7010

帖子ID超过最大长度

4504

图书iD为空

7008

图书ID超过最大长度

6001

图书分类ID不能为空

7009

图书分类ID超过最大长度

7011

帖子分数超过最大界限

8 互帮互助

8.1 addtionHelpQuetion 追加提问接口

8.1.1 接口描述

追加提问,在操作结果提示标签中使用

8.1.2 最后修改信息

8.1.3 调用方

8.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

questionId

Request

String

1

问题Id

addtionContent

Request

String

1

问题内容

响应消息体

字段名

父字段名

字段类型

出现次数

描述

8.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.1.6 报文样例

请求方法

 
POST /portalapi/addtionHelpQuetion

请求报文

 
<Request>
    <questionId>30</questionId>
    <addtionContent>我是谁</addtionContent>
</Request>
 

响应报文

  
 

8.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3406

追加提问失败

4055

问题ID为空

4056

问题ID应为整型

4058

问题内容为空

8.2 getHelpBigTypeList 获取互帮互助官方解答大类型分类列表接口

8.2.1 接口描述

获取互帮互助官方解答大类型分类列表,在互帮互助官方解答大类型分类列表标签中使用

8.2.2 最后修改信息

8.2.3 调用方

8.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

typeCodeList

Request

String

0...1

要查询的大类型的TypeCode列表,以逗号分隔,不填查询所有

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总条数

helpBigTypeList

Response

List

1

大类型信息列表

HelpBigTypeInfo

helpBigTypeList

HelpBigTypeInfo

0...N

大类型信息

typeId

HelpBigTypeInfo

String

1

大类型Id

typeCode

HelpBigTypeInfo

String

1

大类型TypeCode

typeName

HelpBigTypeInfo

String

1

大类型名称

8.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.2.6 报文样例

请求方法

 
POST /portalapi/getHelpBigTypeList

请求报文

 
<Request>
    <typeCodeList></typeCodeList>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <helpBigTypeList>
        <HelpBigTypeInfo>
            <typeId>1</typeId>
            <typeCode>1000</typeCode>
            <typeName>操作问题</typeName>
        </HelpBigTypeInfo>
        <HelpBigTypeInfo>
            <typeId>2</typeId>
            <typeCode>2000</typeCode>
            <typeName>界面问题</typeName>
        </HelpBigTypeInfo>
    </helpBigTypeList>
</Response>
 

8.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4200

大类型的TypeCode为空

4201

大类型的TypeCode为非数字

8.3 getHelpLabelList 查询问题分类接口

8.3.1 接口描述

查询问题分类,以分类的英文首字母分组并从A-Z排序,在互帮互助-问题分类标签中使用

8.3.2 最后修改信息

8.3.3 调用方

8.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

labelIndexList

Request

String

0...1

要查询的问题分类的英文首字母,以逗号分隔,不填查询所有

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总条数

labelList

Response

List

1

按英文首字母分组的列表

HelpLabelInfo

labelList

HelpLabelInfo

0...N

分组信息

lableIndex

HelpLabelInfo

String

1

分组的英文首字母

typeList

HelpLabelInfo

List

1

相同英文首字母的分类列表

HelpTypeInfo

typeList

HelpTypeInfo

1

分类信息

typeId

HelpTypeInfo

String

1

分类Id

typeCode

HelpTypeInfo

String

1

分类编码

typeName

HelpTypeInfo

String

1

分类名称

lableIndex

HelpTypeInfo

String

1

分类所属的英文首字母

8.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.3.6 报文样例

请求方法

 
POST /portalapi/getHelpLabelList

请求报文

 
<Request>
    <labelIndexList></labelIndexList>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>10</totalRecordCount>
    <labelList>
        <HelpLabelInfo>
            <lableIndex>B</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>2</typeId>
                    <typeCode>2</typeCode>
                    <typeName>包月</typeName>
                    <lableIndex>B</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>C</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>8</typeId>
                    <typeCode>20</typeCode>
                    <typeName>促销</typeName>
                    <lableIndex>C</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>D</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>6</typeId>
                    <typeCode>3</typeCode>
                    <typeName>点播</typeName>
                    <lableIndex>D</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>G</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>28</typeId>
                    <typeCode>18</typeCode>
                    <typeName>更新</typeName>
                    <lableIndex>G</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>P</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>25</typeId>
                    <typeCode>14</typeCode>
                    <typeName>排行</typeName>
                    <lableIndex>P</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>Q</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>1</typeId>
                    <typeCode>1</typeCode>
                    <typeName>书券</typeName>
                    <lableIndex>Q</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>9</typeId>
                    <typeCode>21</typeCode>
                    <typeName>其他</typeName>
                    <lableIndex>Q</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>S</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>17</typeId>
                    <typeCode>5</typeCode>
                    <typeName>书架</typeName>
                    <lableIndex>S</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>18</typeId>
                    <typeCode>6</typeCode>
                    <typeName>书评</typeName>
                    <lableIndex>S</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>19</typeId>
                    <typeCode>7</typeCode>
                    <typeName>书签</typeName>
                    <lableIndex>S</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>20</typeId>
                    <typeCode>8</typeCode>
                    <typeName>收藏</typeName>
                    <lableIndex>S</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>24</typeId>
                    <typeCode>13</typeCode>
                    <typeName>搜索</typeName>
                    <lableIndex>S</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>T</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>26</typeId>
                    <typeCode>15</typeCode>
                    <typeName>投票</typeName>
                    <lableIndex>T</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>X</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>27</typeId>
                    <typeCode>16</typeCode>
                    <typeName>献花</typeName>
                    <lableIndex>X</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
        <HelpLabelInfo>
            <lableIndex>Z</lableIndex>
            <typeList>
                <HelpTypeInfo>
                    <typeId>7</typeId>
                    <typeCode>4</typeCode>
                    <typeName>赠送</typeName>
                    <lableIndex>Z</lableIndex>
                </HelpTypeInfo>
                <HelpTypeInfo>
                    <typeId>32</typeId>
                    <typeCode>17</typeCode>
                    <typeName>字数</typeName>
                    <lableIndex>Z</lableIndex>
                </HelpTypeInfo>
            </typeList>
        </HelpLabelInfo>
    </labelList>
</Response>
 

8.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4200

大类型的TypeCode为空

4201

大类型的TypeCode为非数字

8.4 getHelpOfficialAnswerInfo 获取官方解答答案详情接口

8.4.1 接口描述

获取官方解答答案详情,官方解答详情标签中使用

8.4.2 最后修改信息

8.4.3 调用方

8.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

questionId

Request

String

1

问题Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

helpOfficialAnserInfo

Response

questionId

helpOfficialAnserInfo

String

1

问题Id

auditResult

helpOfficialAnserInfo

String

0...1

审核状态

answer

helpOfficialAnserInfo

String

1

答案内容

mobile

helpOfficialAnserInfo

String

1

解答用户手机号

createtime

helpOfficialAnserInfo

String

1

回答时间

nicename

helpOfficialAnserInfo

String

0...1

解答用户昵称

lastupdatetime

helpOfficialAnserInfo

String

1

最后更新时间

8.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.4.6 报文样例

请求方法

 
POST /portalapi/getHelpOfficialAnswerInfo

请求报文

 
<Request>
    <questionId>62</questionId>
</Request>
 

响应报文

  
<Response>
    <helpOfficialAnserInfo>
        <questionId>62</questionId>
        <auditResult>4</auditResult>
        <answer>
                操作步骤:
                    1,进入互动互帮互助首页
                    2,找到‘在线提问’,并点击
                    3,输入你要提出的问题,并分类,提交
                    4,成功提交,完成互帮互助问题提交
    </answer>
        <mobile>10658080</mobile>
        <createtime>20110916024052</createtime>
        <nicename>管理员</nicename>
        <lastupdatetime>20110916024052</lastupdatetime>
    </helpOfficialAnserInfo>
</Response>
 

8.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3405

无答案详情

4055

问题ID为空

4056

问题ID应为整型

8.5 getHelpOfficialQuestionInfo 查询官方解答问题详情接口

8.5.1 接口描述

查询官方解答问题详情,官方解答详情标签中使用

8.5.2 最后修改信息

8.5.3 调用方

8.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

questionId

Request

String

1

问题Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

helpQuestion

Response

helpQuestion

1

问题详情

questionId

helpQuestion

String

1

问题Id

status

helpQuestion

String

1

问题状态

typeCode

helpQuestion

String

1

分类编码

mobile

helpQuestion

String

1

用户手机号

nickName

helpQuestion

String

0...1

用户昵称

title

helpQuestion

String

1

标题

content

helpQuestion

String

0...1

内容

bestAnswerId

helpQuestion

String

0...1

最佳答案Id

createTime

helpQuestion

String

1

创建时间

updateTime

helpQuestion

String

1

最后更新时间

officialSmallTypeName

helpQuestion

String

0...1

问题状态

officialBigTypeName

helpQuestion

String

0...1

问题状态

8.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.5.6 报文样例

请求方法

 
POST /portalapi/getHelpOfficialQuestionInfo

请求报文

 
<Request>
    <questionId>62</questionId>
</Request>
 

响应报文

  
<Response>
    <helpQuestion>
        <questionId>62</questionId>
        <status>1</status>
        <typeCode>0</typeCode>
        <mobile>10658080</mobile>
        <nickName>管理员</nickName>
        <title>手机阅读互动互帮互助如何提交问题?</title>
        <content>内容啊</content>
        <bestAnswerId>63</bestAnswerId>
        <createTime>20110916024052</createTime>
        <updateTime>20110916024052</updateTime>
        <officialSmallTypeName>WAP</officialSmallTypeName>
        <officialBigTypeName>操作问题</officialBigTypeName>
    </helpQuestion>
</Response>
 

8.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3400

无此问题信息

4055

问题ID为空

4056

问题ID应为整型

8.6 getHelpSmallTypeList 获取官方解答小类型列表接口

8.6.1 接口描述

获取官方解答小类型列表,在官方解答小类型列表标签中使用

8.6.2 最后修改信息

8.6.3 调用方

8.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bigTypeCode

Request

String

1

所在大类型的TypeCode

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总条数

helpSmallTypeList

Response

List

1

小类型信息列表

HelpSmallTypeInfo

helpSmallTypeList

HelpSmallTypeInfo

0...N

小类型信息

typeId

HelpSmallTypeInfo

String

1

类型Id

typeCode

HelpSmallTypeInfo

String

1

小类型TypeCode

typeName

HelpSmallTypeInfo

String

1

小类型名称

8.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.6.6 报文样例

请求方法

 
POST /portalapi/getHelpSmallTypeList

请求报文

 
<Request>
    <bigTypeCode>1000</bigTypeCode>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <helpSmallTypeList>
        <HelpSmallTypeInfo>
            <typeId>3</typeId>
            <typeCode>1001</typeCode>
            <typeName>WAP</typeName>
        </HelpSmallTypeInfo>
        <HelpSmallTypeInfo>
            <typeId>4</typeId>
            <typeCode>1002</typeCode>
            <typeName>客户端</typeName>
        </HelpSmallTypeInfo>
    </helpSmallTypeList>
</Response>
 

8.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4200

所在大类型的TypeCode为空

4201

所在大类型的TypeCode为非数字

8.7 isMyQuestionById 是否是我的提问接口

8.7.1 接口描述

判断是否是我的提问。用于在问题详情标签中显示追加

8.7.2 最后修改信息

8.7.3 调用方

8.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

questionId

Request

String

1

问题Id

mobile

Request

String

1

用户手机号码

响应消息体

字段名

父字段名

字段类型

出现次数

描述

8.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

8.7.6 报文样例

请求方法

 
POST /portalapi/isMyQuestionById

请求报文

 
<Request>
    <questionId>109</questionId>
    <mobile>15077870000</mobile>
</Request>
 

响应报文

  
 

8.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3202

属于我的问题

3203

不属于我的问题

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4055

问题ID为空

4056

问题ID应为整型

9 其他

9.1 getBlockReserveInfo 查询模块定制信息接口

9.1.1 接口描述

根据用户阅读号和定制key值查询该用户定制信息

9.1.2 最后修改信息

9.1.3 调用方

9.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

key

Request

String

1

定制信息key

响应消息体

字段名

父字段名

字段类型

出现次数

描述

value

Response

String

1

定制信息value

9.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

9.1.6 报文样例

请求方法

 
POST /portalapi/getBlockReserveInfo

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <key>aaa</key>
</Request>
 

响应报文

  
<Response>
    <value>bbb</value>
</Response>
 

9.1.7 接口响应码

响应码

描述

200

成功

2000

其他错误

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4511

定制key为空

9.2 setBlockReserveInfo 设置模块定制信息接口

9.2.1 接口描述

根据用户阅读号和定制key值查询是否存在记录,如果存在,更新定制信息;如查询记录不存在,则新增记录

9.2.2 最后修改信息

9.2.3 调用方

9.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

key

Request

String

1

定制信息key

value

Request

String

1

定制信息value

响应消息体

字段名

父字段名

字段类型

出现次数

描述

9.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

9.2.6 报文样例

请求方法

 
POST /portalapi/setBlockReserveInfo

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <key>aaa</key>
    <value>bbb</value>
</Request>
 

响应报文

  
 

9.2.7 接口响应码

响应码

描述

200

成功

2000

其他错误

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4511

定制key为空

4512

定制value为空

10 废弃

10.1 addUserMember 添加会员信息接口

10.1.1 接口描述

添加会员信息。在snswap有调用,但没有标签使用

10.1.2 最后修改信息

10.1.3 调用方

10.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

memberId

Request

String

0

用户Id,垃圾字段

userName

Request

String

1

用户名

passWord

Request

String

0...1

密码

adminId

Request

String

0

管理组编号,垃圾字段

lastpost

Request

String

0

最后一次发帖时间,垃圾字段

posts

Request

String

0

发帖总数,垃圾字段

digestPosts

Request

String

0

精华帖,垃圾字段

credits

Request

String

0

评分,垃圾字段

extcredits1

Request

String

0

积分,垃圾字段

extcredits2

Request

String

0

威望,垃圾字段

extcredits3

Request

String

0

金钱,垃圾字段

extcredits4

Request

String

0

预留字段,垃圾字段

extcredits5

Request

String

0

预留字段,垃圾字段

extcredits6

Request

String

0

预留字段,垃圾字段

extcredits7

Request

String

0

预留字段,垃圾字段

extcredits8

Request

String

0

预留字段,垃圾字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.1.6 报文样例

请求方法

 
POST /portalapi/addUserMember

请求报文

 
<Request>
    <memberId></memberId>
    <userName>15077870000</userName>
    <passWord>123456</passWord>
    <adminId></adminId>
    <lastpost></lastpost>
    <posts></posts>
    <digestPosts></digestPosts>
    <credits></credits>
    <extcredits1></extcredits1>
    <extcredits2></extcredits2>
    <extcredits3></extcredits3>
    <extcredits4></extcredits4>
    <extcredits5></extcredits5>
    <extcredits6></extcredits6>
    <extcredits7></extcredits7>
    <extcredits8></extcredits8>
</Request>
 

响应报文

  
 

10.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3601

添加会员失败

4151

会员名称为空

10.2 addUserMemberExt 添加扩展用户信息接口

10.2.1 接口描述

添加扩展用户信息。在snswap有调用,但没有标签使用

10.2.2 最后修改信息

10.2.3 调用方

10.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

membersExtId

Request

String

0...1

扩展用户信息Id

userId

Request

String

1

用户Id

nickName

Request

String

0...1

昵称

mobile

Request

String

1

手机号

userAgent

Request

String

0...1

型号终端

notes

Request

String

0...1

用户说明

age

Request

String

0...1

年龄

sex

Request

String

0...1

性别(0:男,1:女 -1:保密)

provinceId

Request

String

0...1

省份编码

userPassword

Request

String

0...1

密码

question

Request

String

0...1

取回密码问题

answer

Request

String

0...1

取回密码答案

cityId

Request

String

0...1

地市编码

signature

Request

String

0...1

用户签名

interest

Request

String

0...1

爱好

firstPageId

Request

String

0...1

用户登录进入页面的编码存放用户登录进入页面的编码(0:书城,1:书吧,2:书房)

lastOnlineDate

Request

String

0...1

用户最后鉴权时间

activeDate

Request

String

0...1

用户激活日期

userName

Request

String

0...1

用户姓名

idCard

Request

String

0...1

用户身份证号码

userState

Request

String

0...1

用户当前状态(DEFAULT 0) 0:正常 1:暂停 2:停机 3:欠费 4:黑名单不能登录 5:待激活用户 6:黑名单不能使用 9 已注销

address

Request

String

0...1

用户地址

zipcode

Request

String

0...1

用户邮政编码

homePhone

Request

String

0...1

用户家庭电话号码

officePhone

Request

String

0...1

用户办公室电话

faxPhone

Request

String

0...1

用户传真

loginDate

Request

String

0...1

用户注册时间

email

Request

String

0...1

用户Email

roleId

Request

String

0...1

用户角色(0:普通用户 1:测试用户2:管理员)

pageWordCount

Request

String

0...1

分页字数

headId

Request

String

0...1

头像标识

descriptionInfo

Request

String

0...1

描述

gradeId

Request

String

0...1

级别编码

clientVersion

Request

String

0...1

客户端版本

clientChannel

Request

String

0...1

客户端下载渠道

flux

Request

String

0...1

是否收取流量费(是否收取流量费;0:不收取,1:收取)

bookChapterOrderType

Request

cityName

Request

String

0...1

所在城市名

firstPurchase

Request

String

0...1

industryId

Request

String

0...1

isIndustryUserFlag

Request

String

0...1

isMember

Request

String

0...1

onlineState

Request

String

0...1

provinceGrade

Request

String

0...1

provinceName

Request

String

0...1

所在省名称

scheduleUpdate

Request

String

0...1

subscribeRemind

Request

String

0...1

syncTime

Request

String

0...1

同步信息时间

userMemberId

Request

String

0...1

用户信息Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.2.6 报文样例

请求方法

 
POST /portalapi/addUserMemberExt

请求报文

 
<Request>
    <membersExtId></membersExtId>
    <userId>1</userId>
    <nickName></nickName>
    <mobile>15077870000</mobile>
    <userAgent></userAgent>
    <notes></notes>
    <age></age>
    <sex></sex>
    <provinceId></provinceId>
    <userPassword></userPassword>
    <question></question>
    <answer></answer>
    <cityId></cityId>
    <signature></signature>
    <interest></interest>
    <firstPageId></firstPageId>
    <lastOnlineDate></lastOnlineDate>
    <activeDate></activeDate>
    <userName></userName>
    <idCard></idCard>
    <userState></userState>
    <address></address>
    <zipcode></zipcode>
    <homePhone></homePhone>
    <officePhone></officePhone>
    <faxPhone></faxPhone>
    <loginDate></loginDate>
    <email></email>
    <roleId></roleId>
    <pageWordCount></pageWordCount>
    <headId></headId>
    <descriptionInfo></descriptionInfo>
    <gradeId></gradeId>
    <clientVersion></clientVersion>
    <clientChannel></clientChannel>
    <flux></flux>
    <bookChapterOrderType></bookChapterOrderType>
    <cityName></cityName>
    <firstPurchase></firstPurchase>
    <industryId></industryId>
    <isIndustryUserFlag></isIndustryUserFlag>
    <isMember></isMember>
    <onlineState></onlineState>
    <provinceGrade></provinceGrade>
    <provinceName></provinceName>
    <scheduleUpdate></scheduleUpdate>
    <subscribeRemind></subscribeRemind>
    <syncTime></syncTime>
    <userMemberId></userMemberId>
</Request>
 

响应报文

  
 

10.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3600

通过会员名查询会员失败

3603

添加扩展用户信息失败

10.3 batchValidateVIP 批量查询用户是否是悦大使接口

10.3.1 接口描述

批量查询用户是否是悦大使。主平台server中调用

10.3.2 最后修改信息

10.3.3 调用方

10.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdnList

Request

List

1

手机号(虚拟号)列表

string

msisdnList

String

1...N

手机号(虚拟号)

响应消息体

字段名

父字段名

字段类型

出现次数

描述

beanList

Response

List

1

悦大使列表

bean

beanList

bean

0...N

手机号(虚拟号)信息

msisdn

bean

String

1

手机号(虚拟号)信息

isvip

bean

String

1

是否是悦大使,1:是,2:不是

10.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.3.6 报文样例

请求方法

 
POST /portalapi/batchValidateVIP

请求报文

 
<Request>
    <msisdnList>
        <string>15077870000</string>
        <string>13630620000</string>
    </msisdnList>
</Request>
 

响应报文

  
<Response>
    <beanList>
        <bean>
            <msisdn>15077870000</msisdn>
            <isvip>1</isvip>
        </bean>
        <bean>
            <msisdn>13630620000</msisdn>
            <isvip>0</isvip>
        </bean>
    </beanList>
</Response>
 

10.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

10.4 countMBlogList 获取我的/他的日志数量接口

10.4.1 接口描述

获取我的/他的日志数量,查询传入的手机号列表所发布的日志总数。snswap有调用,但没有标签使用

10.4.2 最后修改信息

10.4.3 调用方

10.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

start

Request

String

0

分页编号,垃圾字段

count

Request

String

0

分页长度,垃圾字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

10.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.4.6 报文样例

请求方法

 
POST /portalapi/countMBlogList

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
        <string>13588164850</string>
    </mobileList>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>62</totalCount>
</Response>
 

10.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

10.5 getAllLiveMessage 获取直播间留言接口

10.5.1 接口描述

获取直播间留言按时间降序,过滤掉状态为已删除和已屏蔽的留言和话题留言,snswap中有调用,但标签中未使用

10.5.2 最后修改信息

10.5.3 调用方

10.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveMessageList

Response

List

1

留言列表

LiveMessage

liveMessageList

LiveMessage

0...N

留言信息

roomId

LiveMessage

String

1

直播间ID

messageTime

LiveMessage

String

1

留言时间

mobile

LiveMessage

String

1

用户手机号

niceName

LiveMessage

String

1

昵称

userArea

LiveMessage

String

1

用户归属地

messageContent

LiveMessage

String

1

用户留言内容

memberId

LiveMessage

String

1

审核人员ID

messageState

LiveMessage

String

1

留言状态,0:先审后发(未审核)1:已删除、2:已屏蔽、3:先发后审、4:审核通过

displayOrder

LiveMessage

String

1

是否置顶,0:否、1:

digest

LiveMessage

String

1

是否加精,0:否、1:

floors

LiveMessage

String

1

楼层

topicId

LiveMessage

String

0..1

话题id

10.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.5.6 报文样例

请求方法

 
POST /portalapi/getAllLiveMessage

请求报文

 
<Request>
    <roomId>157</roomId>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveMessageList>
        <LiveMessage>
            <roomId>157</roomId>
            <messageTime>20120514205459</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>太闹心</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>2</floors>
            <topicId>2</topicId>
        </LiveMessage>
        <LiveMessage>
            <roomId>157</roomId>
            <messageTime>20120514205149</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>太闹心</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>1</floors>
        </LiveMessage>
    </liveMessageList>
</Response>
 

10.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4009

直播间ID为空

4010

直播间ID为非数字

10.6 getBlogsCountByBook 获取提到书的日志总数接口

10.6.1 接口描述

获取提到书的日志总数。snswap没有调用

10.6.2 最后修改信息

10.6.3 调用方

10.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

String

1

总记录数

list

Response

List

0...1

提到书日志列表

entry

list

entry

1...N

提到书日志信息

bid

entry

String

1

图书Id

count

entry

String

1

图书被提到的次数

10.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.6.6 报文样例

请求方法

 
POST /portalapi/getBlogsCountByBook

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <total>23</total>
    <list>
        <entry>
            <bid>137270019</bid>
            <count>1</count>
        </entry>
        <entry>
            <bid>137216590</bid>
            <count>1</count>
        </entry>
    </list>
</Response>
 

10.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

10.7 getLiveTopicMessage 获取直播间留言接口

10.7.1 接口描述

获取直播间留言按时间降序,过滤掉状态为已删除和已屏蔽的留言,snswap中有调用,但标签中未使用

10.7.2 最后修改信息

10.7.3 调用方

10.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

topicId

Request

String

1

话题ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveMessageList

Response

List

1

留言列表

LiveMessage

liveMessageList

LiveMessage

0...N

留言信息

roomId

LiveMessage

String

1

直播间ID

messageTime

LiveMessage

String

1

留言时间

mobile

LiveMessage

String

1

用户手机号

niceName

LiveMessage

String

1

昵称

userArea

LiveMessage

String

1

用户归属地

messageContent

LiveMessage

String

1

用户留言内容

memberId

LiveMessage

String

1

审核人员ID

messageState

LiveMessage

String

1

留言状态,0:先审后发(未审核)1:已删除、2:已屏蔽、3:先发后审、4:审核通过

topicId

LiveMessage

String

1

话题ID

displayOrder

LiveMessage

String

1

是否置顶,0:否、1:

digest

LiveMessage

String

1

是否加精,0:否、1:

floors

LiveMessage

String

1

楼层

10.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.7.6 报文样例

请求方法

 
POST /portalapi/getLiveTopicMessage

请求报文

 
<Request>
    <roomId>151</roomId>
    <topicId>142</topicId>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveMessageList>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514215017</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>喊破喉咙也没用的</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <topicId>142</topicId>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>2</floors>
        </LiveMessage>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514214713</messageTime>
            <mobile>13630620000</mobile>
            <niceName>136****0000</niceName>
            <userArea>吉林吉林</userArea>
            <messageContent>助けてくれ!</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <topicId>142</topicId>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>1</floors>
        </LiveMessage>
    </liveMessageList>
</Response>
 

10.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4009

直播间ID为空

4010

直播间ID为非数字

4203

话题ID为空

4204

话题ID应为整型

10.8 getUserBlogsByBook 查询用户提到书的日志列表接口

10.8.1 接口描述

查询用户发表的提到某本指定书的日志列表。snswap没有使用

10.8.2 最后修改信息

10.8.3 调用方

10.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号(虚拟号)

bid

Request

String

1

提到书Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

since

Request

String

0...1

起始时间,格式yyyyMMddHHmmss。不填:查询一个月内的日志

响应消息体

字段名

父字段名

字段类型

出现次数

描述

blogs

Response

List

1

日志列表

MBlogInfo

blogs

MBlogInfo

0...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog__source

MBlogInfo

String

1

日志来源

url

MBlogInfo

String

0...1

url

10.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.8.6 报文样例

请求方法

 
POST /portalapi/getUserBlogsByBook

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <bid>1</bid>
    <start>1</start>
    <count>2</count>
    <since></since>
</Request>
 

响应报文

  
<Response>
    <blogs>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id></ref__book__id>
            <ref__book__keywords></ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog__source></blog__source>
            <url></url>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000524</mblog__id>
            <create__form>0</create__form>
            <mblog__text>gjhljk</mblog__text>
            <ref__book__id>1</ref__book__id>
            <ref__book__keywords>1</ref__book__keywords>
            <ref__subject__id>2</ref__subject__id>
            <ref__subject__keywords>2</ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120502155844</create__time>
            <issue__status>0</issue__status>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id>3</room__id>
            <room__name>3</room__name>
            <blog__source>0</blog__source>
        </MBlogInfo>
    </blogs>
</Response>
 

10.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20001

日志ID为空

20002

日志ID类型错误

20034

时间格式错误

10.9 getUserComments 查询指定用户的评论列表接口

10.9.1 接口描述

查询指定用户的评论列表。在日志广场标签中使用

10.9.2 最后修改信息

10.9.3 调用方

10.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号(虚拟号)

start

Request

String

1

分页编号

count

Request

String

1

分页长度

since

Request

String

0...1

起始时间,格式yyyyMMddHHmmss。不填:查询一个月内的日志

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogCommentList

Response

List

1

日志评论列表

MBlogCommentInfo

mblogCommentList

MBlogCommentInfo

0...N

评论信息

commentId

MBlogCommentInfo

String

1

日志Id

issue__status

MBlogCommentInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

audit__status

MBlogCommentInfo

String

1

审核状态 0:待审核,1:已审核

mblogId

MBlogCommentInfo

String

1

日志Id

mblogText

MBlogCommentInfo

String

1

评论内容

createTime

MBlogCommentInfo

String

1

发表时间

commentSource

MBlogCommentInfo

String

1

评论来源

10.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.9.6 报文样例

请求方法

 
POST /portalapi/getUserComments

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <start>1</start>
    <count>2</count>
    <since></since>
</Request>
 

响应报文

  
<Response>
    <mblogCommentList>
        <MBlogCommentInfo>
            <commentId>47861</commentId>
            <issue__status>0</issue__status>
            <audit__status>0</audit__status>
            <mblogId>1</mblogId>
            <mblogText>#悦读中国#</mblogText>
            <createTime>2012-03-08 18:42:59.0</createTime>
            <commentSource>0</commentSource>
        </MBlogCommentInfo>
        <MBlogCommentInfo>
            <commentId>47862</commentId>
            <issueStatus>0</issueStatus>
            <auditStatus>0</auditStatus>
            <mblogId>1</mblogId>
            <mblogText>#悦读中国#</mblogText>
            <createTime>2012-03-08 18:42:60.0</createTime>
            <commentSource>0</commentSource>
        </MBlogCommentInfo>
    </mblogCommentList>
</Response>
 

10.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20034

时间格式错误

10.10 isBookCoupons 是否可以生成书券

10.10.1 接口描述

判断是否可以生成书券。snswap有调用,但没有标签使用

10.10.2 最后修改信息

10.10.3 调用方

10.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisn

Request

String

1

用户手机号码

point

Request

String

1

要兑换的积分数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.10.6 报文样例

请求方法

 
POST /portalapi/isBookCoupons

请求报文

 
<Request>
    <msisn>15077870000</msisn>
    <point>100</point>
</Request>
 

响应报文

  
 

10.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4202

积分兑换数值为空

4203

积分兑换数值应为double

4444

用户积分不够

4445

积分详情表中无此用户或无此用户积分信息

10.11 upadateMblogWeiboid 更新日志同步到新浪的新浪ID接口

10.11.1 接口描述

更新日志同步到新浪的新浪IDsnswap有调用,但没有标签使用

10.11.2 最后修改信息

10.11.3 调用方

10.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

weiboid

Request

String

1

新浪ID

mblogid

Request

String

1

日志Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.11.6 报文样例

请求方法

 
POST /portalapi/upadateMblogWeiboid

请求报文

 
<Request>
    <weiboid>2147483539</weiboid>
    <mblogid>3000361</mblogid>
</Request>
 

响应报文

  
 

10.11.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20001

日志ID为空

20002

日志ID类型错误

20033

新浪微博ID为空

10.12 updateUserMemberById 更新会员信息接口

10.12.1 接口描述

更新会员信息。在snswap有调用,但没有标签使用

10.12.2 最后修改信息

10.12.3 调用方

10.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

memberId

Request

String

1

用户Id

userName

Request

String

0

用户名,垃圾字段

passWord

Request

String

0...1

密码

adminId

Request

String

0...1

管理组编号

lastpost

Request

String

0...1

最后一次发帖时间

posts

Request

String

0...1

发帖总数

digestPosts

Request

String

0...1

精华帖

credits

Request

String

0...1

评分

extcredits1

Request

String

0...1

积分

extcredits2

Request

String

0...1

威望

extcredits3

Request

String

0...1

金钱

extcredits4

Request

String

0...1

预留字段

extcredits5

Request

String

0...1

预留字段

extcredits6

Request

String

0...1

预留字段

extcredits7

Request

String

0...1

预留字段

extcredits8

Request

String

0...1

预留字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.12.6 报文样例

请求方法

 
POST /portalapi/updateUserMemberById

请求报文

 
<Request>
    <memberId>2006127</memberId>
    <userName></userName>
    <passWord></passWord>
    <adminId></adminId>
    <lastpost></lastpost>
    <posts>10</posts>
    <digestPosts></digestPosts>
    <credits></credits>
    <extcredits1></extcredits1>
    <extcredits2></extcredits2>
    <extcredits3></extcredits3>
    <extcredits4></extcredits4>
    <extcredits5></extcredits5>
    <extcredits6></extcredits6>
    <extcredits7></extcredits7>
    <extcredits8></extcredits8>
</Request>
 

响应报文

  
 

10.12.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3602

更新会员信息失败

4153

会员id为空

10.13 updateUserMemberExtById 修改用户扩展信息接口

10.13.1 接口描述

修改用户扩展信息。在snswap有调用,但没有标签使用

10.13.2 最后修改信息

10.13.3 调用方

10.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

membersExtId

Request

String

1

扩展用户信息Id

userId

Request

String

0...1

用户Id

nickName

Request

String

0...1

昵称

mobile

Request

String

0...1

手机号

userAgent

Request

String

0...1

型号终端

notes

Request

String

0...1

用户说明

age

Request

String

0...1

年龄

sex

Request

String

0...1

性别(0:男,1:女 -1:保密)

provinceId

Request

String

0...1

省份编码

userPassword

Request

String

0...1

密码

question

Request

String

0...1

取回密码问题

answer

Request

String

0...1

取回密码答案

cityId

Request

String

0...1

地市编码

signature

Request

String

0...1

用户签名

interest

Request

String

0...1

爱好

firstPageId

Request

String

0...1

用户登录进入页面的编码存放用户登录进入页面的编码(0:书城,1:书吧,2:书房)

lastOnlineDate

Request

String

0...1

用户最后鉴权时间

activeDate

Request

String

0...1

用户激活日期

userName

Request

String

0...1

用户姓名

idCard

Request

String

0...1

用户身份证号码

userState

Request

String

0...1

用户当前状态(DEFAULT 0) 0:正常 1:暂停 2:停机 3:欠费 4:黑名单不能登录 5:待激活用户 6:黑名单不能使用 9 已注销

address

Request

String

0...1

用户地址

zipcode

Request

String

0...1

用户邮政编码

homePhone

Request

String

0...1

用户家庭电话号码

officePhone

Request

String

0...1

用户办公室电话

faxPhone

Request

String

0...1

用户传真

loginDate

Request

String

0...1

用户注册时间

email

Request

String

0...1

用户Email

roleId

Request

String

0...1

用户角色(0:普通用户 1:测试用户2:管理员)

pageWordCount

Request

String

0...1

分页字数

headId

Request

String

0...1

头像标识

descriptionInfo

Request

String

0...1

描述

gradeId

Request

String

0...1

级别编码

clientVersion

Request

String

0...1

客户端版本

clientChannel

Request

String

0...1

客户端下载渠道

flux

Request

String

0...1

是否收取流量费(是否收取流量费;0:不收取,1:收取)

bookChapterOrderType

Request

cityName

Request

String

0...1

所在城市名

firstPurchase

Request

String

0...1

industryId

Request

String

0...1

isIndustryUserFlag

Request

String

0...1

isMember

Request

String

0...1

onlineState

Request

String

0...1

provinceGrade

Request

String

0...1

provinceName

Request

String

0...1

所在省名称

scheduleUpdate

Request

String

0...1

subscribeRemind

Request

String

0...1

syncTime

Request

String

0...1

同步信息时间

userMemberId

Request

String

0...1

用户信息Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

10.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

10.13.6 报文样例

请求方法

 
POST /portalapi/updateUserMemberById

请求报文

 
<Request>
    <membersExtId>2005299</membersExtId>
    <userId></userId>
    <nickName>呵呵</nickName>
    <mobile></mobile>
    <userAgent></userAgent>
    <notes></notes>
    <age></age>
    <sex></sex>
    <provinceId></provinceId>
    <userPassword></userPassword>
    <question></question>
    <answer></answer>
    <cityId></cityId>
    <signature></signature>
    <interest></interest>
    <firstPageId></firstPageId>
    <lastOnlineDate></lastOnlineDate>
    <activeDate></activeDate>
    <userName></userName>
    <idCard></idCard>
    <userState></userState>
    <address></address>
    <zipcode></zipcode>
    <homePhone></homePhone>
    <officePhone></officePhone>
    <faxPhone></faxPhone>
    <loginDate></loginDate>
    <email></email>
    <roleId></roleId>
    <pageWordCount></pageWordCount>
    <headId></headId>
    <descriptionInfo></descriptionInfo>
    <gradeId></gradeId>
    <clientVersion></clientVersion>
    <clientChannel></clientChannel>
    <flux></flux>
    <bookChapterOrderType></bookChapterOrderType>
    <cityName></cityName>
    <firstPurchase></firstPurchase>
    <industryId></industryId>
    <isIndustryUserFlag></isIndustryUserFlag>
    <isMember></isMember>
    <onlineState></onlineState>
    <provinceGrade></provinceGrade>
    <provinceName></provinceName>
    <scheduleUpdate></scheduleUpdate>
    <subscribeRemind></subscribeRemind>
    <syncTime></syncTime>
    <userMemberId></userMemberId>
</Request>
 

响应报文

  
 

10.13.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3605

更新扩展用户信息失败

4154

扩展用户id为空

11 微博

11.1 addCommentTesk 当新增抓取日志评论任务接口

11.1.1 接口描述

当悦大使发日志同步到第三方微博时,新增一个抓取该日志评论的任务。在发日志同步到第三方微博时使用

11.1.2 最后修改信息

11.1.3 调用方

11.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

blogId

Request

String

1

日志Id

blogid__sina

Request

String

1

第三方微博id

platformType

Request

String

1

平台类型

dbType

Request

String

1

数据库类别(1互动,2论坛)

响应消息体

字段名

父字段名

字段类型

出现次数

描述

11.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.1.6 报文样例

请求方法

 
POST /portalapi/addCommentTesk

请求报文

 
<Request>
    <blogId>3000501</blogId>
    <blogid__sina>123456</blogid__sina>
    <platformType>1</platformType>
    <dbType>1</dbType>
</Request>
 

响应报文

  
 

11.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

40013

微博ID为空

40014

账号类型为空

40015

新浪微博ID为空

40016

数据库类别为空

11.2 applyStarAuthor 申请悦大使接口

11.2.1 接口描述

申请悦大使。在职业申请标签中使用

11.2.2 最后修改信息

11.2.3 调用方

11.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

11.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.2.6 报文样例

请求方法

 
POST /portalapi/applyStarAuthor

请求报文

 
<Request>
    <msisdn>15077870001</msisdn>
</Request>
 

响应报文

  
 

11.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

40028

此号码已经是悦大使

40029

此号码的申请信息已经是待审核状态

40039

第三方账号的虚拟号不能申请悦大使

11.3 auditChange 日志或评论批量审核接口

11.3.1 接口描述

互动manager在对日志或评论审核后通知我们出话单

11.3.2 最后修改信息

11.3.3 调用方

11.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

type

Request

String

1

类型:1、日志,2、评论

idList

Request

List

1

日志或评论ID列表

string

idList

String

1..N

日志或评论ID

sourceType

Request

String

0..1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

portalType

Request

String

0..1

门户类型:1:WAP,2:WWW,3手持,4:客户端,5:客服,6:其他,7:短信,8:MM,9:实体卡,11:iPad,12:互动门户,13:SIG

channelCode

Request

String

0..1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

响应消息体

字段名

父字段名

字段类型

出现次数

描述

11.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.3.6 报文样例

请求方法

 
POST /portalapi/auditChange

请求报文

 
<Request>
    <type>1</type>
    <idList>
        <string>12345</string>
    </idList>
    <sourceType>1</sourceType>
    <portalType>12</portalType>
    <channelCode>0000</channelCode>
</Request>
 

响应报文

  
 

11.3.7 接口响应码

响应码

描述

200

成功

500309

日志或评论审核参数为空

500310

日志或评论审核类型错误

500311

日志或评论批量审核失败

11.4 delCommentTesk 删除悦大使抓取日志评论任务接口

11.4.1 接口描述

删除悦大使抓取日志评论任务。在删除帖子结果标签中使用

11.4.2 最后修改信息

11.4.3 调用方

11.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

blogId

Request

String

1

日志Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

11.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.4.6 报文样例

请求方法

 
POST /portalapi/delCommentTesk

请求报文

 
<Request>
    <blogId>3000501</blogId>
</Request>
 

响应报文

  
 

11.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20301

删除日志时 , 删除抓取评论任务中失败

40013

微博ID为空

11.5 deleteMblog 删除日志

11.5.1 接口描述

门户调用此接口进行删除日志操作(软删除)

11.5.2 最后修改信息

11.5.3 调用方

11.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号码

mblogId

Request

String

1

日志Id

platform

Request

String

0..1

门户类型

channelCode

Request

String

0..1

营销渠道ID

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

firstCatalog

Request

String

0...1

一级目录

secondCatalog

Request

String

0...1

二级目录

thirdCatalog

Request

String

0...1

三级目录

currentCatalog

Request

String

0...1

当前目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

11.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.5.6 报文样例

请求方法

 
POST /portalapi/deleteMblog

请求报文

 
<Request>
    <mobile>15191466619</mobile>
    <mblogId>3000126</mblogId>
    <platform>12</platform>
    <channelCode>0001</channelCode>
    <sourceType>1</sourceType>
    <firstCatalog>121</firstCatalog>
    <secondCatalog>133</secondCatalog>
    <thirdCatalog>320</thirdCatalog>
    <currentCatalog>323</currentCatalog>
</Request>
 

响应报文

  
 

11.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

20001

日志ID为空

20002

日志ID类型错误

20301

删除日志失败

11.6 getAllSTARAuthorInLabel 获取悦名家轮播标签配置接口

11.6.1 接口描述

获取悦名家轮播标签配置以实现门户对悦名家轮播信息进行展示功能

11.6.2 最后修改信息

11.6.3 调用方

11.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

ordernum

Request

int

1

请求记录条数

status

Request

int

1

状态,1显示,0隐藏

响应消息体

字段名

父字段名

字段类型

出现次数

描述

allStarAuthorInLabelList

Response

List

0...1

悦名家轮播标签配置列表

allStarAuthorInLabel

allStarAuthorInLabelList

AllStarAuthorInLabel

1...N

悦名家轮播标签配置信息

id

allStarAuthorInLabel

int

0...1

序号

msisdn

allStarAuthorInLabel

string

0...1

悦名家的手机号

bookid

allStarAuthorInLabel

string

0...1

图书ID

readnote

allStarAuthorInLabel

string

0...1

领读笔记

detailurl

allStarAuthorInLabel

string

0...1

详情URL

status

allStarAuthorInLabel

int

0...1

状态,1显示,0隐藏

11.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.6.6 报文样例

请求方法

 
POST /portalapi/getAllSTARAuthorInLabel

请求报文

 
<Request>
    <ordernum>1</ordernum>
    <status>1</status>
</Request>
 

响应报文

  
<Response>
    <allStarAuthorInLabelList>
        <allStarAuthorInLabel>
            <id>1001</id>
            <msisdn>15151887108</msisdn>
            <bookid>3203</bookid>
            <readnote>笔记笔录</readnote>
            <detailurl>小水细流</detailurl>
            <status>1</status>
        </allStarAuthorInLabel>
    </allStarAuthorInLabelList>
</Response>
 

11.6.7 接口响应码

响应码

描述

500333

请求记录条数非法

500334

状态值不为0或者1

500335

请求记录数为空

500336

请求状态为空

11.7 getBookReadTimes 获取图书阅读用户数

11.7.1 接口描述

获取图书阅读用户数。图书展示跟读人数的时候使用

11.7.2 最后修改信息

11.7.3 调用方

11.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookid

Request

String

1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

bookid

Response

String

1

图书ID

readTimes

Response

String

1

阅读用户数

11.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.7.6 报文样例

请求方法

 
POST /portalapi/getBookReadTimes

请求报文

 
<Request>
    <bookid>13546</bookid>
</Request>
 

响应报文

  
<Response>
    <bookid>13546</bookid>
    <readTimes>13546</readTimes>
</Response>
 

11.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4504

图书id为空

500307

暂无图书阅读信息

11.8 getCelebrityLabelInfo 获取悦读大使分类信息接口

11.8.1 接口描述

获取悦读大使分类信息。在分类悦读大使更多标签中使用

11.8.2 最后修改信息

11.8.3 调用方

11.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

categoryId

Request

String

1

分类Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

label

Response

label

0...1

悦读大使分类信息

categoryId

label

String

1

分类Id

categoryName

label

String

1

分类名称

sort

label

String

1

排序

createTime

label

String

1

创建时间

11.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.8.6 报文样例

请求方法

 
POST /portalapi/getCelebrityLabelInfo

请求报文

 
<Request>
    <categoryId>22</categoryId>
</Request>
 

响应报文

  
<Response>
    <label>
        <categoryId>22</categoryId>
        <categoryName>作者</categoryName>
        <sort>3</sort>
        <createTime>2011-12-31</createTime>
    </label>
</Response>
 

11.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20009

分类查询类型为空

20010

分类查询类型错误

11.9 getCelebrityLabelList 获取悦读大使分类列表接口

11.9.1 接口描述

获取悦读大使分类列表。在悦读大使读书日志标签和悦读大使读书日志更多标签和全部悦读大使标签和snswap缓存中使用

11.9.2 最后修改信息

11.9.3 调用方

11.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

list

Response

List

0...1

悦读大使分类列表

label

list

label

1...N

悦读大使分类信息

categoryId

label

String

1

分类Id

categoryName

label

String

1

分类名称

sort

label

String

1

排序

createTime

label

String

1

创建时间

11.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.9.6 报文样例

请求方法

 
POST /portalapi/getCelebrityLabelList

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>4</totalCount>
    <list>
        <label>
            <categoryId>22</categoryId>
            <categoryName>作者</categoryName>
            <sort>3</sort>
            <createTime>2011-12-31</createTime>
        </label>
        <label>
            <categoryId>23</categoryId>
            <categoryName>小品</categoryName>
            <sort>4</sort>
            <createTime>2011-12-31</createTime>
        </label>
    </list>
</Response>
 

11.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.10 getCelebrityListByLabel 获取悦读大使分类下的悦大使列表接口

11.10.1 接口描述

获取悦读大使分类下的悦大使列表。在悦读大使读书日志标签和全部悦读大使标签和分类悦读大使更多标签和snswap缓存中使用

11.10.2 最后修改信息

11.10.3 调用方

11.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

categoryId

Request

String

1

分类Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

list

Response

List

0...1

悦大使列表

celebrity

list

List

1...N

悦大使

msisdn

celebrity

List

1

悦大使手机号

11.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.10.6 报文样例

请求方法

 
POST /portalapi/getCelebrityListByLabel

请求报文

 
<Request>
    <categoryId>23</categoryId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>4</totalCount>
    <list>
        <celebrity>
            <msisdn>15077870000</msisdn>
        </celebrity>
        <celebrity>
            <msisdn>15077870001</msisdn>
        </celebrity>
    </list>
</Response>
 

11.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20009

分类查询类型为空

20010

分类查询类型错误

11.11 getCMIdByMsisdn 查询悦大使的营销参数接口

11.11.1 接口描述

根据悦大使的手机号码查询营销参数。在主平台中使用

11.11.2 最后修改信息

11.11.3 调用方

11.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

cmId

Response

String

1

营销参数,不是悦大使则返回000000

11.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.11.6 报文样例

请求方法

 
POST /portalapi/getCMIdByMsisdn

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <cmId>00000M</cmId>
</Response>
 

11.11.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

11.12 getCommentById 根据评论id获取评论信息接口

11.12.1 接口描述

根据评论id获取评论信息。在评论详情标签中使用

11.12.2 最后修改信息

11.12.3 调用方

11.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

commentId

Request

String

1

日志评论Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogCommentInfo

Response

mblogCommentInfo

0...1

日志评论信息

commentId

mblogCommentInfo

String

1

日志评论Id

mobile

mblogCommentInfo

String

1

手机号(虚拟号)

issue__status

mblogCommentInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

audit__status

mblogCommentInfo

String

1

审核状态 0:待审核,1:已审核

mblogId

mblogCommentInfo

String

1

日志Id

mblogText

mblogCommentInfo

String

1

日志内容

createTime

mblogCommentInfo

String

1

发表时间

commentSource

mblogCommentInfo

String

1

评论来源

11.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.12.6 报文样例

请求方法

 
POST /portalapi/getCommentById

请求报文

 
<Request>
    <commentId>48266</commentId>
</Request>
 

响应报文

  
<Response>
    <mblogCommentInfo>
        <commentId>48266</commentId>
        <mobile>15077870000</mobile>
        <issue__status>0</issue__status>
        <audit__status>0</audit__status>
        <mblogId>3000736</mblogId>
        <mblogText>评论一手</mblogText>
        <createTime>20120523114405</createTime>
        <commentSource>0</commentSource>
    </mblogCommentInfo>
</Response>
 

11.12.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20007

评论id为空

20008

评论id类型错误

20104

该日志评论不存在

11.13 getFamousPersonGrade 查询悦大使职业等级接口

11.13.1 接口描述

根据手机号查询悦大使职业等级。在职业申请标签中使用

11.13.2 最后修改信息

11.13.3 调用方

11.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

grade

Response

String

1

职业等级

11.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.13.6 报文样例

请求方法

 
POST /portalapi/getFamousPersonGrade

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <grade>0</grade>
</Response>
 

11.13.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

20015

该用户不是悦大使

11.14 getFamousPersonInfoById 根据手机号(虚拟手机号)获取悦大使的认证信息接口

11.14.1 接口描述

根据手机号(虚拟手机号)获取悦大使的认证信息。在变更通知中使用

11.14.2 最后修改信息

11.14.3 调用方

11.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

famousPersonInfoBean

Response

famousPersonInfoBean

0...1

悦大使信息

msisdn

famousPersonInfoBean

String

1

手机号

VIPImage

famousPersonInfoBean

String

1

封面图片

addTime

famousPersonInfoBean

String

1

创建时间

authenInfo

famousPersonInfoBean

String

0...1

认证信息

score

famousPersonInfoBean

String

1

用户职业积分

grade

famousPersonInfoBean

String

1

用户职业等级

cmId

famousPersonInfoBean

String

1

悦大使唯一标识

11.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.14.6 报文样例

请求方法

 
POST /portalapi/getFamousPersonInfoById

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <famousPersonInfoBean>
        <msisdn>15077870000</msisdn>
        <VIPImage>/star/201205/{imagePath}/1337778203292.jpg</VIPImage>
        <addTime>2012-05-23 17:08:47</addTime>
        <authenInfo>hehe</authenInfo>
        <score>0</score>
        <grade>0</grade>
        <cmId>00000M</cmId>
    </famousPersonInfoBean>
</Response>
 

11.14.7 接口响应码

响应码

描述

200

成功

2000

程序异常

500501

阅读号不能为空

11.15 getFamousPersonInfoList 获取所有已认证的悦大使信息列表接口

11.15.1 接口描述

获取所有已认证的悦大使信息列表。在snswap缓存中使用

11.15.2 最后修改信息

11.15.3 调用方

11.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

famousPersonInfoBeanList

Response

List

0...1

悦大使列表

FamousPersonInfoBean

famousPersonInfoBeanList

FamousPersonInfoBean

1...N

悦大使信息

msisdn

FamousPersonInfoBean

String

1

手机号

addTime

FamousPersonInfoBean

String

1

创建时间

authenInfo

FamousPersonInfoBean

String

0...1

认证信息

score

FamousPersonInfoBean

String

1

用户职业积分

grade

FamousPersonInfoBean

String

1

用户职业等级

cmId

FamousPersonInfoBean

String

1

悦大使唯一标识

11.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.15.6 报文样例

请求方法

 
POST /portalapi/getFamousPersonInfoList

请求报文

 
 

响应报文

  
<Response>
    <famousPersonInfoBeanList>
        <FamousPersonInfoBean>
            <msisdn>13588164890</msisdn>
            <addTime>2012-05-23 17:42:43</addTime>
            <authenInfo>hehe</authenInfo>
            <score>0</score>
            <grade>0</grade>
            <cmId>00000N</cmId>
        </FamousPersonInfoBean>
        <FamousPersonInfoBean>
            <msisdn>13588164898</msisdn>
            <addTime>2012-05-23 17:42:43</addTime>
            <authenInfo>hehe</authenInfo>
            <score>0</score>
            <grade>0</grade>
            <cmId>00000O</cmId>
        </FamousPersonInfoBean>
    </famousPersonInfoBeanList>
</Response>
 

11.15.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.16 getHotMBlogList 获取热门微薄列表接口

11.16.1 接口描述

获取热门微薄列表。在日志广场标签中使用

11.16.2 最后修改信息

11.16.3 调用方

11.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogList

Response

List

1

日志列表

MBlogInfo

mblogList

MBlogInfo

0...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog_source

MBlogInfo

String

0...1

日志来源

url

MBlogInfo

String

0...1

url

sheetid

MBlogInfo

String

0...1

书单id

11.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.16.6 报文样例

请求方法

 
POST /portalapi/getHotMBlogList

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <mblogList>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id></ref__book__id>
            <ref__book__keywords></ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>50</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog_source></blog_source>
            <url></url>
            <sheetid></sheetid>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000738</mblog__id>
            <create__form>1</create__form>
            <ref__mblog__id>3000730</ref__mblog__id>
            <mblog__text>//@小飞://@小飞:3232</mblog__text>
            <mobile>13588164850</mobile>
            <create__time>20120522152501</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>40</comment__times>
        </MBlogInfo>
        <totalRecordCount>50</totalRecordCount>
    </mblogList>
</Response>
 

11.16.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.17 getMBlogCommentList 获取日志评论列表接口

11.17.1 接口描述

根据日志Id获取日志评论列表。在日志广场标签中使用

11.17.2 最后修改信息

11.17.3 调用方

11.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mblogId

Request

String

1

日志Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

mblogCommentList

Response

List

1

日志评论列表

MBlogCommentInfo

mblogCommentList

MBlogCommentInfo

0...N

评论信息

commentId

MBlogCommentInfo

String

1

日志Id

mobile

MBlogCommentInfo

String

1

手机号(虚拟号)

issue__status

MBlogCommentInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

audit__status

MBlogCommentInfo

String

1

审核状态 0:待审核,1:已审核

mblogId

MBlogCommentInfo

String

1

日志Id

mblogText

MBlogCommentInfo

String

1

评论内容

createTime

MBlogCommentInfo

String

1

发表时间

commentSource

MBlogCommentInfo

String

1

评论来源

11.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.17.6 报文样例

请求方法

 
POST /portalapi/getMBlogCommentList

请求报文

 
<Request>
    <mblogId>1</mblogId>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <mblogCommentList>
        <MBlogCommentInfo>
            <commentId>47861</commentId>
            <mobile>13588164858</mobile>
            <issue__status>0</issue__status>
            <audit__status>0</audit__status>
            <mblogId>1</mblogId>
            <mblogText>#悦读中国#</mblogText>
            <createTime>2012-03-08 18:42:59.0</createTime>
            <commentSource>0</commentSource>
        </MBlogCommentInfo>
        <MBlogCommentInfo>
            <commentId>47862</commentId>
            <mobile>13588164858</mobile>
            <issueStatus>0</issueStatus>
            <auditStatus>0</auditStatus>
            <mblogId>1</mblogId>
            <mblogText>#悦读中国#</mblogText>
            <createTime>2012-03-08 18:42:60.0</createTime>
            <commentSource>0</commentSource>
        </MBlogCommentInfo>
    </mblogCommentList>
</Response>
 

11.17.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20001

日志ID为空

20002

日志ID类型错误

11.18 getMBlogInfo 获取日志详情接口

11.18.1 接口描述

根据日志ID获取日志详情信息,在日志详情标签和日志广场标签和更多日志标签和转发日志标签和个人空间日志列表标签中使用

11.18.2 最后修改信息

11.18.3 调用方

11.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mblog__id

Request

String

1

日志Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogInfo

Response

mblogInfo

0...1

日志信息

mblog__id

mblogInfo

String

1

日志Id

create__form

mblogInfo

String

0...1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

mblogInfo

String

0

第三方微博Id,垃圾字段

ref__mblog__id

mblogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

mblogInfo

String

1

日志内容

ref__book__id

mblogInfo

String

0...1

提到书Id

ref__book__keywords

mblogInfo

String

0...1

提到书关键字

ref__subject__id

mblogInfo

String

0...1

提到话题id

ref__subject__keywords

mblogInfo

String

0...1

话题关键字

mobile

mblogInfo

String

1

手机号(虚拟号)

create__time

mblogInfo

String

1

发表时间

audit__status

mblogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

mblogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

mblogInfo

String

1

点击次数

forward__times

mblogInfo

String

1

转发次数

comment__times

mblogInfo

String

1

评论次数

room__id

mblogInfo

String

0...1

直播间Id

room__name

mblogInfo

String

0...1

直播间名称

blog__source

mblogInfo

String

1

日志来源

mblog_type

mblogInfo

String

0...1

日志类型:0:默认普通日志 1:领取图书

url

mblogInfo

String

0...1

url

sheetid

mblogInfo

String

0...1

书单id

11.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.18.6 报文样例

请求方法

 
POST /portalapi/getMBlogInfo

请求报文

 
<Request>
    <mblog__id>3000730</mblog__id>
</Request>
 

响应报文

  
<Response>
    <mblogInfo>
        <mblog__id>3000730</mblog__id>
        <create__form>0</create__form>
        <weibo__id></weibo__id>
        <ref__mblog__id></ref__mblog__id>
        <mblog__text>#悦读中国#哇伊儿嘿呼</mblog__text>
        <ref__book__id></ref__book__id>
        <ref__book__keywords></ref__book__keywords>
        <ref__subject__id>1</ref__subject__id>
        <ref__subject__keywords>悦读中国</ref__subject__keywords>
        <mobile>13588164850</mobile>
        <create__time>20120522120554</create__time>
        <audit__status>0</audit__status>
        <issue__status>0</issue__status>
        <click__times>0</click__times>
        <forward__times>0</forward__times>
        <comment__times>0</comment__times>
        <room__id>1</room__id>
        <room__name>1</room__name>
        <blog__source>0</blog__source>
        <mblog_type>0</mblog_type>
        <url></url>
        <sheetid></sheetid>
    </mblogInfo>
</Response>
 

11.18.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20001

日志ID为空

20002

日志ID类型错误

20003

该日志不存在

11.19 getMBlogList 获取日志列表接口

11.19.1 接口描述

根据手机号列表获取日志列表。在更多日志标签和个人空间日志列表标签中使用

11.19.2 最后修改信息

11.19.3 调用方

11.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogList

Response

List

0...1

日志列表

MBlogInfo

mblogList

mblogInfo

1...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog__source

MBlogInfo

String

1

日志来源

url

MBlogInfo

String

0...1

url

sheetid

MBlogInfo

String

0...1

书单id

11.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.19.6 报文样例

请求方法

 
POST /portalapi/getMBlogList

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
        <string>13588164850</string>
    </mobileList>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <mblogList>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id></ref__book__id>
            <ref__book__keywords></ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog__source></blog__source>
            <url></url>
            <sheetid></sheetid>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000738</mblog__id>
            <create__form>1</create__form>
            <ref__mblog__id>3000730</ref__mblog__id>
            <mblog__text>//@小飞://@小飞:3232</mblog__text>
            <mobile>13588164850</mobile>
            <create__time>20120522152501</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
        </MBlogInfo>
    </mblogList>
</Response>
 

11.19.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.20 getMBLogListByLabel 获取悦读大使分类下的日志列表接口

11.20.1 接口描述

获取悦读大使分类下的日志列表。在悦读大使读书日志更多标签中使用

11.20.2 最后修改信息

11.20.3 调用方

11.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

categoryId

Request

String

1

日志Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

list

Response

List

0...1

日志列表

mblog

list

mblog

1...N

日志信息

msisdn

mblog

String

1

手机号(虚拟号)

mblogId

mblog

String

1

日志Id

mblogText

mblog

String

1

日志内容

createTime

mblog

String

1

发表时间

issue__status

mblog

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

forward__times

mblog

String

1

转发次数

comment__times

mblog

String

1

评论次数

11.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.20.6 报文样例

请求方法

 
POST /portalapi/getMBLogListByLabel

请求报文

 
<Request>
    <categoryId>23</categoryId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>5</totalCount>
    <list>
        <mblog>
            <msisdn>15077870000</msisdn>
            <mblogId>3000736</mblogId>
            <mblogText>洗洗更健康</mblogText>
            <createTime>2012-05-22</createTime>
            <issue__status>0</issue__status>
            <forward__times>1</forward__times>
            <comment__times>1</comment__times>
        </mblog>
        <mblog>
            <msisdn>15077870000</msisdn>
            <mblogId>3000534</mblogId>
            <mblogText>fasdf</mblogText>
            <createTime>2012-05-02</createTime>
            <issueStatus>0</issueStatus>
            <forwardTimes>0</forwardTimes>
            <commentTimes>0</commentTimes>
        </mblog>
    </list>
</Response>
 

11.20.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20009

分类查询类型为空

20010

分类查询类型错误

11.21 getMBLogListByLeader 获取名家领读日志列表接口

11.21.1 接口描述

获取名家领读日志列表,给门户展示

11.21.2 最后修改信息

11.21.3 调用方

11.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

名家ID(手机号/阅读号/第三方用户的虚拟号)

bookid

Request

String

1

领读图书ID

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

leadMBLogInfoList

Response

List

0...1

日志列表

mblog

leadMBLogInfoList

mblog

1...N

日志信息

mblogId

mblog

String

1

日志Id

mblogText

mblog

String

0...1

日志内容

refBookKeywords

mblog

String

0...1

提到书关键字

refBookid

mblog

String

0...1

提到书ID

issueStatus

mblog

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

createTime

mblog

String

1

发表时间,格式YYYYMMddHHmmss

forwardTimes

mblog

String

1

转发次数

commentTimes

mblog

String

1

评论次数

11.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.21.6 报文样例

请求方法

 
POST /portalapi/getMBLogListByLeader

请求报文

 
<Request>
    <msisdn>13770712841</msisdn>
    <bookid>123456</bookid>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>5</totalCount>
    <leadMBLogInfoList>
        <mblog>
            <mblogId>3000736</mblogId>
            <mblogText>洗洗更健康</mblogText>
            <refBookKeywords>洗洗</refBookKeywords>
            <refBookid>1354</refBookid>
            <issueStatus>0</issueStatus>
            <createTime>20120522000000</createTime>
            <forwardTimes>1</forwardTimes>
            <commentTimes>1</commentTimes>
        </mblog>
    </leadMBLogInfoList>
</Response>
 

11.21.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4004

分页编号为非数字

4006

分页长度为非数字

22000

用户账号为空

500305

图书id为空

11.22 getMoreMBlogList 获取更多日志列表接口

11.22.1 接口描述

根据手机号列表获取日志列表(以及获取第一个手机号的关注的日志列表)。在更多日志标签和个人空间日志列表标签中使用

11.22.2 最后修改信息

11.22.3 调用方

11.22.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogList

Response

List

0...1

日志列表

MBlogInfo

mblogList

mblogInfo

0...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog__source

MBlogInfo

String

1

日志来源

url

MBlogInfo

String

0...1

url

sheetid

MBlogInfo

String

0...1

书单id

11.22.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.22.6 报文样例

请求方法

 
POST /portalapi/getMoreMBlogList

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
        <string>13588164850</string>
    </mobileList>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <mblogList>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id></ref__book__id>
            <ref__book__keywords></ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog__source></blog__source>
            <url></url>
            <sheetid></sheetid>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000738</mblog__id>
            <create__form>1</create__form>
            <ref__mblog__id>3000730</ref__mblog__id>
            <mblog__text>//@小飞://@小飞:3232</mblog__text>
            <mobile>13588164850</mobile>
            <create__time>20120522152501</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
        </MBlogInfo>
    </mblogList>
</Response>
 

11.22.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.23 getNewComment 获取最新评论列表接口

11.23.1 接口描述

获取最新评论列表。在精彩|最新评论标签和精彩|最新评论更多标签中使用

11.23.2 最后修改信息

11.23.3 调用方

11.23.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

mblogCommentList

Response

List

1

日志评论列表

MBlogCommentInfo

mblogCommentList

MBlogCommentInfo

0...N

日志评论信息

commentId

MBlogCommentInfo

String

1

日志评论Id

mobile

MBlogCommentInfo

String

1

手机号(虚拟号)

issue__status

MBlogCommentInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

audit__status

MBlogCommentInfo

String

1

审核状态 0:待审核,1:已审核

mblog__id

MBlogCommentInfo

String

1

日志Id

mblog__text

MBlogCommentInfo

String

1

日志内容

create__time

MBlogCommentInfo

String

1

发表时间

11.23.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.23.6 报文样例

请求方法

 
POST /portalapi/getNewComment

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>20</totalRecordCount>
    <mblogCommentList>
        <MBlogCommentInfo>
            <commentId>52</commentId>
            <mobile>15077870000</mobile>
            <issue__status>0</issue__status>
            <audit__status>0</audit__status>
            <mblog__id>115</mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <create__time>20120522161740</create__time>
        </MBlogCommentInfo>
        <MBlogCommentInfo>
            <commentId>51</commentId>
            <mobile>13526458659</mobile>
            <issueStatus>0</issueStatus>
            <auditStatus>0</auditStatus>
            <mblogId>115</mblogId>
            <mblogText>sadad</mblogText>
            <createTime>20120104164934</createTime>
        </MBlogCommentInfo>
    </mblogCommentList>
</Response>
 

11.23.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.24 getNewMBlogList 获取最新微薄列表接口

11.24.1 接口描述

获取最新微薄列表。在日志广场标签中使用

11.24.2 最后修改信息

11.24.3 调用方

11.24.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogList

Response

List

1

日志列表

MBlogInfo

mblogList

MBlogInfo

0...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog_source

MBlogInfo

String

0...1

日志来源

url

MBlogInfo

String

0...1

url

sheetid

MBlogInfo

String

0...1

书单id

11.24.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.24.6 报文样例

请求方法

 
POST /portalapi/getNewMBlogList

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <mblogList>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id></ref__book__id>
            <ref__book__keywords></ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog_source></blog_source>
            <url></url>
            <sheetid></sheetid>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000738</mblog__id>
            <create__form>1</create__form>
            <ref__mblog__id>3000730</ref__mblog__id>
            <mblog__text>//@小飞://@小飞:3232</mblog__text>
            <mobile>13588164850</mobile>
            <create__time>20120522152501</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
        </MBlogInfo>
        <totalRecordCount>50</totalRecordCount>
    </mblogList>
</Response>
 

11.24.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.25 getRefBookMBlogList 获取提到书日志列表接口

11.25.1 接口描述

获取提到书日志列表。在提到书的日志列表标签中使用

11.25.2 最后修改信息

11.25.3 调用方

11.25.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

refBookId

Request

String

1

提到书Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

mblogList

Response

List

1

日志列表

MBlogInfo

mblogList

MBlogInfo

0...N

日志信息

mblog__id

MBlogInfo

String

1

日志Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

weibo__id

MBlogInfo

String

0

新浪微博Id,垃圾字段

ref__mblog__id

MBlogInfo

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

日志内容

ref__book__id

MBlogInfo

String

0...1

提到书Id

ref__book__keywords

MBlogInfo

String

0...1

提到书关键字

ref__subject__id

MBlogInfo

String

0...1

提到话题id

ref__subject__keywords

MBlogInfo

String

0...1

话题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

audit__status

MBlogInfo

String

1

审核状态 0:待审核,1:已审核

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

click__times

MBlogInfo

String

1

点击次数

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

0...1

直播间Id

room__name

MBlogInfo

String

0...1

直播间名称

blog_source

MBlogInfo

String

0...1

日志来源

url

MBlogInfo

String

0...1

url

11.25.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.25.6 报文样例

请求方法

 
POST /portalapi/getRefBookMBlogList

请求报文

 
<Request>
    <refBookId>1</refBookId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>4</totalCount>
    <mblogList>
        <MBlogInfo>
            <mblog__id>3000739</mblog__id>
            <create__form>2</create__form>
            <weibo__id></weibo__id>
            <ref__mblog__id>3000736</ref__mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <ref__book__id>1</ref__book__id>
            <ref__book__keywords>111</ref__book__keywords>
            <ref__subject__id></ref__subject__id>
            <ref__subject__keywords></ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120522161740</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>50</comment__times>
            <room__id></room__id>
            <room__name></room__name>
            <blog_source></blog_source>
            <url></url>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000523</mblog__id>
            <create__form>0</create__form>
            <mblog__text>gjhljk</mblog__text>
            <ref__book__id>1</ref__book__id>
            <ref__book__keywords>1</ref__book__keywords>
            <ref__subject__id>2</ref__subject__id>
            <ref__subject__keywords>2</ref__subject__keywords>
            <mobile>15077870000</mobile>
            <create__time>20120502155757</create__time>
            <audit__status>0</audit__status>
            <issue__status>0</issue__status>
            <click__times>0</click__times>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id>3</room__id>
            <room__name>3</room__name>
        </MBlogInfo>
    </mblogList>
</Response>
 

11.25.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20201

图书ID为空

20202

图书ID类型错误

11.26 getThirdAccountForOther 其他平台通过虚拟手机号获取第三方账号信息接口

11.26.1 接口描述

其他平台通过虚拟手机号获取第三方账号信息。在snswap没有使用,其他平台有使用

11.26.2 最后修改信息

11.26.3 调用方

11.26.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

虚拟号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

thirdAccountInfo

Response

thirdAccountInfo

0...1

第三方账号信息

msisdn

thirdAccountInfo

String

1

虚拟号

accountType

thirdAccountInfo

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

account

thirdAccountInfo

String

1

账号

nickName

thirdAccountInfo

String

1

用户昵称

headPath

thirdAccountInfo

String

0...1

头像路径

addTime

thirdAccountInfo

String

0...1

导入时间

checkToken

thirdAccountInfo

String

0...1

鉴权token

checkKey

thirdAccountInfo

String

0...1

鉴权密钥

refreshToken

thirdAccountInfo

String

0...1

人人网所需刷新accessToken的密钥

11.26.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.26.6 报文样例

请求方法

 
POST /portalapi/getThirdAccountForOther

请求报文

 
<Request>
    <msisdn>75100013426</msisdn>
</Request>
 

响应报文

  
<Response>
    <thirdAccountInfo>
        <msisdn>75100013426</msisdn>
        <accountType>5</accountType>
        <account>r00201728</account>
        <nickName>小小程序员儿</nickName>
        <headPath>http://tp2.sinaimg.cn/2315410921/50/0/1</headPath>
        <addTime>2012-2-8 10:55:23</addTime>
        <checkToken></checkToken>
        <checkKey></checkKey>
        <refreshToken></refreshToken>
    </thirdAccountInfo>
</Response>
 

11.26.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

20020

虚拟手机号格式不正确,以7开头

11.27 getThirdAccountInfoByNickName 通过昵称获取第三方账号信息接口

11.27.1 接口描述

通过昵称获取第三方账号信息。在搜索结果标签中使用

11.27.2 最后修改信息

11.27.3 调用方

11.27.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

name

Request

String

1

用户昵称

响应消息体

字段名

父字段名

字段类型

出现次数

描述

thirdAccountInfos

Response

List

1

第三方账号信息列表

ThirdAccountInfo

thirdAccountInfos

ThirdAccountInfo

1...N

第三方账号信息

msisdn

ThirdAccountInfo

String

1

虚拟号

accountType

ThirdAccountInfo

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

account

ThirdAccountInfo

String

1

账号

nickName

ThirdAccountInfo

String

1

用户昵称

headPath

ThirdAccountInfo

String

0...1

头像路径

addTime

ThirdAccountInfo

String

0...1

导入时间

checkToken

ThirdAccountInfo

String

0...1

鉴权token

checkKey

ThirdAccountInfo

String

0...1

鉴权密钥

refreshToken

ThirdAccountInfo

String

0...1

人人网所需刷新accessToken的密钥

11.27.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.27.6 报文样例

请求方法

 
POST /portalapi/getThirdAccountInfoByNickName

请求报文

 
<Request>
    <name>小小程序员儿</name>
</Request>
 

响应报文

  
<Response>
    <thirdAccountInfos>
        <ThirdAccountInfo>
            <msisdn>75100013426</msisdn>
            <accountType>5</accountType>
            <account>r00201728</account>
            <nickName>小小程序员儿</nickName>
            <headPath>http://tp2.sinaimg.cn/2315410921/50/0/1</headPath>
            <addTime>2012-2-8 10:55:23</addTime>
            <checkToken></checkToken>
            <checkKey></checkKey>
            <refreshToken></refreshToken>
        </ThirdAccountInfo>
    </thirdAccountInfos>
</Response>
 

11.27.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20011

昵称为空

11.28 getThirdAccountInfoByXMsisdn 通过虚拟手机号获取第三方账号信息接口

11.28.1 接口描述

通过虚拟手机号获取第三方账号信息。在很多标签中都有使用

11.28.2 最后修改信息

11.28.3 调用方

11.28.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

虚拟号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

thirdAccountInfo

Response

thirdAccountInfo

0...1

第三方账号信息

msisdn

thirdAccountInfo

String

1

虚拟号

accountType

thirdAccountInfo

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

account

thirdAccountInfo

String

1

账号

nickName

thirdAccountInfo

String

1

用户昵称

headPath

thirdAccountInfo

String

0...1

头像路径

addTime

thirdAccountInfo

String

0...1

导入时间

checkToken

thirdAccountInfo

String

0...1

鉴权token

checkKey

thirdAccountInfo

String

0...1

鉴权密钥

refreshToken

thirdAccountInfo

String

0...1

人人网所需刷新accessToken的密钥

11.28.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.28.6 报文样例

请求方法

 
POST /portalapi/getThirdAccountInfoByXMsisdn

请求报文

 
<Request>
    <msisdn>75100013426</msisdn>
</Request>
 

响应报文

  
<Response>
    <thirdAccountInfo>
        <msisdn>75100013426</msisdn>
        <accountType>5</accountType>
        <account>r00201728</account>
        <nickName>小小程序员儿</nickName>
        <headPath>http://tp2.sinaimg.cn/2315410921/50/0/1</headPath>
        <addTime>2012-2-8 10:55:23</addTime>
        <checkToken></checkToken>
        <checkKey></checkKey>
        <refreshToken></refreshToken>
    </thirdAccountInfo>
</Response>
 

11.28.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

20020

虚拟手机号格式不正确,以7开头

11.29 getTopComment 获取精彩评论列表接口

11.29.1 接口描述

获取精彩评论列表。在精彩|最新评论标签和精彩|最新评论更多标签中使用

11.29.2 最后修改信息

11.29.3 调用方

11.29.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

start

Request

String

1

分页编号

count

Request

String

1

分页长度

showNum

Request

String

0...1

搜索范围的最大个数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

mblogCommentList

Response

List

1

日志评论列表

MBlogCommentInfo

mblogCommentList

MBlogCommentInfo

0...N

日志评论信息

commentId

MBlogCommentInfo

String

1

日志评论Id

mobile

MBlogCommentInfo

String

1

手机号(虚拟号)

issue__status

MBlogCommentInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

audit__status

MBlogCommentInfo

String

1

审核状态 0:待审核,1:已审核

mblog__id

MBlogCommentInfo

String

1

日志Id

mblog__text

MBlogCommentInfo

String

1

日志内容

create__time

MBlogCommentInfo

String

1

发表时间

11.29.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.29.6 报文样例

请求方法

 
POST /portalapi/getTopComment

请求报文

 
<Request>
    <start>1</start>
    <count>2</count>
    <showNum></showNum>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>20</totalRecordCount>
    <mblogCommentList>
        <MBlogCommentInfo>
            <commentId>52</commentId>
            <mobile>15077870000</mobile>
            <issue__status>0</issue__status>
            <audit__status>0</audit__status>
            <mblog__id>115</mblog__id>
            <mblog__text>表来洗我</mblog__text>
            <create__time>20120522161740</create__time>
        </MBlogCommentInfo>
        <MBlogCommentInfo>
            <commentId>51</commentId>
            <mobile>13526458659</mobile>
            <issueStatus>0</issueStatus>
            <auditStatus>0</auditStatus>
            <mblogId>115</mblogId>
            <mblogText>sadad</mblogText>
            <createTime>20120104164934</createTime>
        </MBlogCommentInfo>
    </mblogCommentList>
</Response>
 

11.29.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20004

显示数量类型错误

11.30 getTopMBlogListByLabel 获取悦读大使分类下的置顶日志列表接口

11.30.1 接口描述

获取悦读大使分类下的置顶日志列表。在悦读大使读书日志标签和snswap缓存中使用

11.30.2 最后修改信息

11.30.3 调用方

11.30.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

categoryId

Request

String

0...1

悦读大使分类Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

list

Response

List

0...1

日志列表

mblog

list

mblog

1...N

日志信息

msisdn

mblog

String

1

手机号(虚拟号)

mblogId

mblog

String

1

日志Id

mblogText

mblog

String

1

日志内容

createTime

mblog

String

1

发表时间 在categoryId为空值时,返回时间为年月日时分秒,不为空时,返回年月日

issue__status

mblog

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

forward__times

mblog

String

1

转发次数

comment__times

mblog

String

1

评论次数

refBookId

mblog

String

0...1

提到书ID categoryId为空值时返回,不为空值,则不返回

refBookKeywords

mblog

String

0...1

提到书关键字,categoryId为空值时返回,不为空值,则不返回

refSubjectId

mblog

String

0...1

提到话题ID categoryId为空值时返回,不为空值,则不返回

refSubjectKeywords

mblog

String

0...1

提到话题关键字 在categoryId为空值时返回,不为空值,则不返回

roomId

mblog

String

0...1

直播间ID categoryId为空值时返回,不为空值,则不返回

roomName

mblog

String

0...1

直播间名称 在categoryId为空值时返回,不为空值,则不返回

11.30.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.30.6 报文样例

请求方法

 
POST /portalapi/getTopMBlogListByLabel

请求报文

 
<Request>
    <categoryId>23</categoryId>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>5</totalCount>
    <list>
        <mblog>
            <msisdn>15077870000</msisdn>
            <mblogId>3000736</mblogId>
            <mblogText>洗洗更健康</mblogText>
            <createTime>2012-05-22</createTime>
            <issue__status>0</issue__status>
            <forward__times>1</forward__times>
            <comment__times>1</comment__times>
            <refBookId></refBookId>
            <refBookKeywords></refBookKeywords>
            <refSubjectId></refSubjectId>
            <refSubjectKeywords></refSubjectKeywords>
            <roomId></roomId>
            <roomName></roomName>
        </mblog>
        <mblog>
            <msisdn>15077870000</msisdn>
            <mblogId>3000534</mblogId>
            <mblogText>fasdf</mblogText>
            <createTime>2012-05-02</createTime>
            <issueStatus>0</issueStatus>
            <forwardTimes>0</forwardTimes>
            <commentTimes>0</commentTimes>
            <refBookId>137430903</refBookId>
            <refBookKeywords>天与地</refBookKeywords>
            <refSubjectId>78799</refSubjectId>
            <refSubjectKeywords>人生路</refSubjectKeywords>
            <roomId>7102</roomId>
            <roomName>聊天室1</roomName>
        </mblog>
    </list>
</Response>
 

11.30.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20009

分类查询类型为空

20010

分类查询类型错误

11.31 qryReceiveComment 查询收到评论接口

11.31.1 接口描述

根据手机号获取收到评论列表

11.31.2 最后修改信息

11.31.3 调用方

11.31.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

评论总数

mblogCommentList

Response

String

1

收到评论列表

MblogComment

mblogCommentList

String

1...N

最新的日志评论

recMobile

MblogComment

String

0...1

收到评论的手机号(虚拟号)

sendMobile

MblogComment

String

0...1

发出评论的手机号(虚拟号)

issueStatus

MblogComment

String

0...1

日志发布状态

auditStatus

MblogComment

String

0...1

日志审核状态

commentIssueStatus

MblogComment

String

0...1

评论发布状态

commentAuditStatus

MblogComment

String

0...1

评论审核状态

mblogId

MblogComment

String

1

日志ID

commentId

MblogComment

String

1

日志评论ID

commentText

MblogComment

String

0...1

评论内容

createTime

MblogComment

String

1

评论时间

weiboId

MblogComment

String

0...1

新浪日志ID

mblogText

MblogComment

String

0...1

日志内容

refBookKeywords

MblogComment

String

0...1

提到的书籍关键字

refBookId

MblogComment

String

0...1

提到的书籍ID

refSubjectId

MblogComment

String

0...1

提到的主题ID

refSubjectKeywords

MblogComment

String

0...1

提到的主题关键字

roomId

MblogComment

String

0...1

提到的直播间ID

roomName

MblogComment

String

0...1

提到的直播间名称

commentTimes

MblogComment

String

0...1

评论次数

createForm

MblogComment

String

0...1

发表类型 原创日志:0 转发日志:1 转发并评论日志:2

refMblogId

MblogComment

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

11.31.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.31.6 报文样例

请求方法

 
POST /portalapi/qryReceiveComment

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
    </mobileList>
    <start>1</start>
    <count>10</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>10</totalCount>
    <mblogCommentList>
        <MblogComment>
            <recMobile>15077870000</recMobile>
            <sendMobile>15236052131</sendMobile>
            <issueStatus>发布状态 0:已发布,1:未发布,2:屏蔽,3:删除</issueStatus>
            <auditStatus>审核状态 待审核:0 已审核:1</auditStatus>
            <commentIssueStatus>发布状态 0:已发布,1:未发布,2:屏蔽,3:删除</commentIssueStatus>
            <commentAuditStatus>审核状态 待审核:0 已审核:1</commentAuditStatus>
            <mblogId>78246</mblogId>
            <commentId>486</commentId>
            <commentText>悦读中国</commentText>
            <createTime>2012-2-16 11:52:32</createTime>
            <weiboId>2147483539</weiboId>
            <mblogText>"停在通往虚空的飘渺之路上..."</mblogText>
            <refBookKeywords>飘渺</refBookKeywords>
            <refBookId>10</refBookId>
            <refSubjectId>11</refSubjectId>
            <refSubjectKeywords>年代爱情小说</refSubjectKeywords>
            <roomId>157</roomId>
            <roomName>任工的小单间</roomName>
            <commentTimes>1</commentTimes>
            <createForm></createForm>
            <refMblogId>1</refMblogId>
        </MblogComment>
    </mblogCommentList>
</Response>
 

11.31.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.32 qryRevSendCommentCount 收到和发出评论数接口

11.32.1 接口描述

根据手机号获取收到和发出评论数

11.32.2 最后修改信息

11.32.3 调用方

11.32.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Response

List

1

手机号列表

string

mobileList

String

1...N

手机号

sendCommentNum

Response

String

1

发出的评论数

receiveCommentNum

Response

String

1

收到的评论数

11.32.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.32.6 报文样例

请求方法

 
POST /portalapi/qryRevSendCommentCount

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
    </mobileList>
</Request>
 

响应报文

  
<Response>
    <mobileList>
        <string>15077870000</string>
    </mobileList>
    <sendCommentNum>100</sendCommentNum>
    <receiveCommentNum>101</receiveCommentNum>
</Response>
 

11.32.7 接口响应码

响应码

描述

200

成功

2000

程序异常

11.33 qrySendComment 查询发出评论接口

11.33.1 接口描述

根据手机号获取发出的评论列表

11.33.2 最后修改信息

11.33.3 调用方

11.33.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobileList

Request

List

1

手机号列表

string

mobileList

String

1...N

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

评论总数

mblogCommentList

Response

String

1

发出的评论列表

MblogComment

mblogCommentList

String

1...N

最新的日志评论

recMobile

MblogComment

String

0...1

收到评论的手机号(虚拟号)

sendMobile

MblogComment

String

0...1

发出评论的手机号(虚拟号)

issueStatus

MblogComment

String

0...1

日志发布状态

auditStatus

MblogComment

String

0...1

日志审核状态

commentIssueStatus

MblogComment

String

0...1

评论发布状态

commentAuditStatus

MblogComment

String

0...1

评论审核状态

mblogId

MblogComment

String

1

日志ID

commentId

MblogComment

String

1

日志评论ID

commentText

MblogComment

String

0...1

评论内容

createTime

MblogComment

String

1

评论时间

weiboId

MblogComment

String

0...1

新浪日志ID

mblogText

MblogComment

String

0...1

日志内容

refBookKeywords

MblogComment

String

0...1

提到的书籍关键字

refBookId

MblogComment

String

0...1

提到的书籍ID

refSubjectId

MblogComment

String

0...1

提到的主题ID

refSubjectKeywords

MblogComment

String

0...1

提到的主题关键字

roomId

MblogComment

String

0...1

提到的直播间ID

roomName

MblogComment

String

0...1

提到的直播间名称

commentTimes

MblogComment

String

0...1

评论次数

createForm

MblogComment

String

0...1

发表类型 原创日志:0 转发日志:1 转发并评论日志:2

refMblogId

MblogComment

String

0...1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

11.33.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.33.6 报文样例

请求方法

 
POST /portalapi/qrySendComment

请求报文

 
<Request>
    <mobileList>
        <string>15077870000</string>
    </mobileList>
    <start>1</start>
    <count>10</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>10</totalCount>
    <mblogCommentList>
        <MblogComment>
            <recMobile>15236052131</recMobile>
            <sendMobile>15077870000</sendMobile>
            <issueStatus>发布状态 0:已发布,1:未发布,2:屏蔽,3:删除</issueStatus>
            <auditStatus>审核状态 待审核:0 已审核:1</auditStatus>
            <commentIssueStatus>发布状态 0:已发布,1:未发布,2:屏蔽,3:删除</commentIssueStatus>
            <commentAuditStatus>审核状态 待审核:0 已审核:1</commentAuditStatus>
            <mblogId>78246</mblogId>
            <commentId>486</commentId>
            <commentText>悦读中国</commentText>
            <createTime>2012-2-16 11:52:32</createTime>
            <weiboId>2147483539</weiboId>
            <mblogText>"停在通往虚空的飘渺之路上..."</mblogText>
            <refBookKeywords>飘渺</refBookKeywords>
            <refBookId>10</refBookId>
            <refSubjectId>11</refSubjectId>
            <refSubjectKeywords>年代爱情小说</refSubjectKeywords>
            <roomId>157</roomId>
            <roomName>任工的小单间</roomName>
            <commentTimes>1</commentTimes>
            <createForm></createForm>
            <refMblogId>1</refMblogId>
        </MblogComment>
    </mblogCommentList>
</Response>
 

11.33.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

11.34 releaseMBlog 发表日志接口

11.34.1 接口描述

发表日志,在实体书同步标签和发日志标签和主持人嘉宾发言转发理由标签和分享理由标签中使用

11.34.2 最后修改信息

11.34.3 调用方

11.34.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

weibo__id

Request

String

0...1

新浪微博Id,垃圾字段

mblog__text

Request

String

1

日志内容

ref__book__id

Request

String

0...1

提到书Id

ref__book__keywords

Request

String

0...1

提到书关键字

ref__subject__id

Request

String

0...1

提到话题id

ref__subject__keywords

Request

String

0...1

提到话题关键字

mobile

Request

String

1

手机号(虚拟号)

room__id

Request

String

0...1

直播间Id

room__name

Request

String

0...1

直播间名称

platform

Request

String

0...1

门户类型,话单字段

channelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

mblogType

Request

String

0...1

日志类型:0:默认普通日志 1:领取图书

url

Request

String

0...1

url

sheetid

Request

String

0...1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogId

Response

String

0...1

新日志Id

11.34.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.34.6 报文样例

请求方法

 
POST /portalapi/releaseMBlog

请求报文

 
<Request>
    <weibo__id></weibo__id>
    <mblog__text>洗洗更健康</mblog__text>
    <ref__book__id></ref__book__id>
    <ref__book__keywords></ref__book__keywords>
    <ref__subject__id></ref__subject__id>
    <ref__subject__keywords></ref__subject__keywords>
    <mobile>15077870000</mobile>
    <room__id></room__id>
    <room__name></room__name>
    <platform>12</platform>
    <channelCode>000001</channelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
    <mblogType>0</mblogType>
    <url></url>
    <sheetid></sheetid>
</Request>
 

响应报文

  
<Response>
    <mblogId>3000736</mblogId>
</Response>
 

11.34.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20006

用户帐号为空

40041

用户在黑名单列表中

11.35 saveOrUpdateWeiboUserInfo 更新/保存第三方账号信息接口

11.35.1 接口描述

更新/保存第三方账号信息(执行存储过程SAVEORUPDATE_WEIBO_USERINFO,首先查询第三方账号信息是否存在,不存在就新增,存在则更新).在登录时调用

11.35.2 最后修改信息

11.35.3 调用方

11.35.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

accountType

Request

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

account

Request

String

1

账号

nickName

Request

String

1

用户昵称

headPath

Request

String

0...1

头像路径

addTime

Request

String

0...1

导入时间

msisdnPre

Request

String

1

虚拟号第一位

weiboType

Request

String

1

虚拟号第二位,4:天涯,5:人人,6:腾讯,7:新浪

weiboToken

Request

String

0...1

微博token

refreshToken

Request

String

0...1

人人网所需刷新accessToken的密钥

checkToken

Request

String

0...1

鉴权token

checkKey

Request

String

0...1

鉴权密钥

响应消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Response

String

1

虚拟号

11.35.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.35.6 报文样例

请求方法

 
POST /portalapi/saveOrUpdateWeiboUserInfo

请求报文

 
<Request>
    <accountType>5</accountType>
    <account>r00201728</account>
    <nickName>小小程序员儿</nickName>
    <headPath>http://tp2.sinaimg.cn/2315410921/50/0/1</headPath>
    <addTime>2012-2-8 10:55:23</addTime>
    <msisdnPre>7</msisdnPre>
    <weiboType>5</weiboType>
    <weiboToken></weiboToken>
    <refreshToken></refreshToken>
    <checkToken></checkToken>
    <checkKey></checkKey>
</Request>
 

响应报文

  
<Response>
    <msisdn>75100013426</msisdn>
</Response>
 

11.35.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20021

账号类型不能为空

20022

账号类型不是整型异常码

20023

账号类型超过一位数字

20024

账号不能为空

20025

呢称不能为空

20026

虚拟手机号前缀不能为空

20027

虚拟手机号前缀不是数字

20028

虚拟手机号前缀超过一位数字

20029

微博类型不能为空

20030

微博类型不是数字

20031

微博类型超过一位数字

11.36 toCommentMBlog 评论日志接口

11.36.1 接口描述

对日志发表评论(写日志评论话单),在评论日志标签和转发日志标签中使用

11.36.2 最后修改信息

11.36.3 调用方

11.36.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mblogId

Request

String

1

日志Id

mobile

Request

String

1

手机号(虚拟号)

mblog__text

Request

String

0...1

日志内容

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

commentId

Response

String

1

评论Id

11.36.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.36.6 报文样例

请求方法

 
POST /portalapi/toCommentMBlog

请求报文

 
<Request>
    <mblogId>3000736</mblogId>
    <mobile>15077870000</mobile>
    <mblog__text></mblog__text>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
<Response>
    <commentId>987</commentId>
</Response>
 

11.36.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20001

日志ID为空

20002

日志ID类型错误

40041

用户在黑名单列表中

11.37 transmitMBlog 转发日志接口

11.37.1 接口描述

转发日志,并为transmit__mblog__id对应的日志累加转发数,在转发日志标签中使用

11.37.2 最后修改信息

11.37.3 调用方

11.37.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

create__form

Request

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

ref__mblog__id

Request

String

1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

weibo__id

Request

String

0

新浪微博Id,垃圾字段

mblog__text

Request

String

1

日志内容

mobile

Request

String

1

手机号(虚拟号)

transmit__mblog__id

Request

String

1

转发的日志Id

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

url

Request

String

0...1

url

响应消息体

字段名

父字段名

字段类型

出现次数

描述

mblogId

Response

String

0...1

新日志Id

11.37.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.37.6 报文样例

请求方法

 
POST /portalapi/transmitMBlog

请求报文

 
<Request>
    <create__form>2</create__form>
    <ref__mblog__id>3000736</ref__mblog__id>
    <weibo__id></weibo__id>
    <mblog__text>表来洗我</mblog__text>
    <mobile>15077870000</mobile>
    <transmit__mblog__id>3000736</transmit__mblog__id>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
    <url></url>
</Request>
 

响应报文

  
<Response>
    <mblogId>3000739</mblogId>
</Response>
 

11.37.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20001

日志ID为空

20002

日志ID类型错误

20006

用户帐号为空

40041

用户在黑名单列表中

11.38 unionFriendsAndFans 合并好友圈接口

11.38.1 接口描述

合并好友圈(新合并的关注和粉丝出话单)。在手机号和虚拟号绑定时使用

11.38.2 最后修改信息

11.38.3 调用方

11.38.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

xuNiMsisdn

Request

String

1

虚拟号

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

channelCode

Request

String

0..1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultCode

Response

String

1

存储过程PRO_FRIENDS_FANS_UNION_CTRL执行状态。1:成功,-1:失败

11.38.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.38.6 报文样例

请求方法

 
POST /portalapi/unionFriendsAndFans

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <xuNiMsisdn>75100013426</xuNiMsisdn>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <channelCode>0000</channelCode>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
<Response>
    <resultCode>1</resultCode>
</Response>
 

11.38.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

20020

虚拟手机号格式不正确,以7开头

11.39 verifyAccount 获取第三方用户信息接口

11.39.1 接口描述

获取第三方用户信息。在外围平台个人空间用户头像标签和用户基本信息标签和外围平台账号展示标签和解除绑定标签和登陆鉴权中使用

11.39.2 最后修改信息

11.39.3 调用方

11.39.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

account

Request

String

1

账号

accountType

Request

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

响应消息体

字段名

父字段名

字段类型

出现次数

描述

thirdAccountInfo

Response

thirdAccountInfo

0...1

第三方账号信息

msisdn

thirdAccountInfo

String

1

虚拟号

accountType

thirdAccountInfo

String

1

账号类型,1:新浪,3:腾讯,5:人人,6:天涯

account

thirdAccountInfo

String

1

账号

nickName

thirdAccountInfo

String

1

用户昵称

headPath

thirdAccountInfo

String

0...1

头像路径

addTime

thirdAccountInfo

String

0...1

导入时间

checkToken

thirdAccountInfo

String

0...1

鉴权token

checkKey

thirdAccountInfo

String

0...1

鉴权密钥

refreshToken

thirdAccountInfo

String

0...1

人人网所需刷新accessToken的密钥

11.39.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

11.39.6 报文样例

请求方法

 
POST /portalapi/verifyAccount

请求报文

 
<Request>
    <account>r00201728</account>
    <accountType>5</accountType>
</Request>
 

响应报文

  
<Response>
    <thirdAccountInfo>
        <msisdn>75100013426</msisdn>
        <accountType>5</accountType>
        <account>r00201728</account>
        <nickName>小小程序员儿</nickName>
        <headPath>http://tp2.sinaimg.cn/2315410921/50/0/1</headPath>
        <addTime>2012-2-8 10:55:23</addTime>
        <checkToken></checkToken>
        <checkKey></checkKey>
        <refreshToken></refreshToken>
    </thirdAccountInfo>
</Response>
 

11.39.7 接口响应码

响应码

描述

200

成功

2000

程序异常

20021

账号类型不能为空

20022

账号类型不是数字

20023

账号类型超过一位数字

20024

账号不能为空

12 成长体系

12.1 doUserTask 任务处理接口

12.1.1 接口描述

提供任务处理接口对任务进行完成操作并下放奖励

12.1.2 最后修改信息

12.1.3 调用方

12.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

taskId

Request

String

1

任务ID

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

处理任务成功

12.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

12.1.6 报文样例

请求方法

 
POST /portalapi/doUserTask

请求报文

 
<Request>
    <taskId>1</taskId>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

12.1.7 接口响应码

响应码

描述

2000

其他错误

500337

阅读号为空

500338

不是阅读号

500339

任务id为空

500340

任务不存在

500341

任务已经失效

500342

任务已经关闭

500346

用户未领取任务

500347

完成任务超出限制

12.2 getUserTask 任务领取接口

12.2.1 接口描述

用手机号和任务id领取任务

12.2.2 最后修改信息

12.2.3 调用方

12.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

taskId

Request

String

1

任务ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

领取任务成功

12.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

12.2.6 报文样例

请求方法

 
POST /portalapi/getUserTask

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <taskId>1</taskId>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

12.2.7 接口响应码

响应码

描述

2000

其他错误

500337

阅读号为空

500338

不是阅读号

500339

任务id为空

500340

任务不存在

500341

任务已经失效

500342

任务已经关闭

500343

领取任务超出限制

500344

用户已经领取任务

500345

用户完成任务可继续领取

12.3 getUserTaskInfo 任务详细信息查询接口

12.3.1 接口描述

根据任务id查询任务详细信息

12.3.2 最后修改信息

12.3.3 调用方

12.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

taskId

Request

String

1

任务ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

taskInfo

Response

taskInfo

1

任务信息

id

taskInfo

String

1

任务Id

name

taskInfo

String

1

任务名称

status

taskInfo

String

1

任务状态

awardsType

taskInfo

String

1

奖励类型

awardsValue

taskInfo

String

1

奖励数值

message

taskInfo

String

1

站内信内容

num

taskInfo

String

1

任务可以完成的次数

postId

taskInfo

String

0...1

任务关联帖子Id

startTime

taskInfo

String

0...1

活动开始时间

endTime

taskInfo

String

0...1

活动结束时间

CycleInfo

taskInfo

CycleInfo

0...1

周期信息

cycle

CycleInfo

String

1

周期(1代表星期天)

cycleStartTime

CycleInfo

String

1

周期活动开始时间

cycleEndTime

CycleInfo

String

1

周期活动结束时间

12.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

12.3.6 报文样例

请求方法

 
POST /portalapi/getUserTaskInfo

请求报文

 
<Request>
    <taskId>1</taskId>
</Request>
 

响应报文

  
<Response>
    <taskInfo>
        <id>1</id>
        <name>猜二猜</name>
        <status>1</status>
        <awardsType>2</awardsType>
        <awardsValue>5</awardsValue>
        <message>用户成功完成任务后</message>
        <num>1</num>
        <postId>1</postId>
        <startTime>1377143928086</startTime>
        <endTime>1377269928081</endTime>
        <CycleInfo>
            <cycle>1,5,4</cycle>
            <cycleStartTime>00:00</cycleStartTime>
            <cycleEndTime>23:00</cycleEndTime>
        </CycleInfo>
    </taskInfo>
</Response>
 

12.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

500339

任务id为空

500340

任务不存在

12.4 getUserTaskInfoByMsisdnAndId 指定任务状态查询接口

12.4.1 接口描述

作为用户,我在登录时,可以查询当前可以领取的任务id列表

12.4.2 最后修改信息

12.4.3 调用方

12.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

id

Request

String

1

任务id

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

id

Response

String

1

任务Id

status

Response

String

1

任务状态1已领取2未领取3已完成4任务无效

12.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

12.4.6 报文样例

请求方法

 
POST /portalapi/getUserTaskInfoByMsisdnAndId

请求报文

 
<Request>
    <id>1</id>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response>
    <id>1</id>
    <status>1</status>
</Response>
 

12.4.7 接口响应码

响应码

描述

2000

其他错误

500337

阅读号为空

500338

不是阅读号

500339

任务id为空

500340

任务不存在

12.5 getUserTaskList 任务列表查询接口

12.5.1 接口描述

作为用户,我在登录时,可以查询当前可以领取的任务id列表

12.5.2 最后修改信息

12.5.3 调用方

12.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

receiveState

Request

String

1

领取状态1、已领取2、未领取3、已完成4、已领取和未领取

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

userTaskStatusList

Response

List

1

用户相关任务信息列表

userTaskStatus

userTaskStatusList

userTaskStatus

1

用户相关任务信息

id

userTaskStatus

String

1

任务Id

taskUserStatus

userTaskStatus

String

1

任务进度:1已领取2未领取3已完成

totalTask

userTaskStatus

String

1

用户完成任务次

12.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

12.5.6 报文样例

请求方法

 
POST /portalapi/getUserTaskList

请求报文

 
<Request>
    <receiveState>1</receiveState>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response>
    <totalCount>1</totalCount>
    <userTaskStatusList>
        <userTaskStatus>
            <id>1</id>
            <taskUserStatus>1</taskUserStatus>
            <totalTask>1</totalTask>
        </userTaskStatus>
    </userTaskStatusList>
</Response>
 

12.5.7 接口响应码

响应码

描述

2000

其他错误

500337

阅读号为空

500338

不是阅读号

500348

搜索条件为空

500349

不存在的搜索类型

13 排行榜

13.1 getBooksShareRankList 获取图书分享排行列表接口

13.1.1 接口描述

根据查询范围(周榜,月榜,总榜),查询所有图书被分享的次数,并按照书目被分享的次数倒序输出,snswap缓存中使用

13.1.2 最后修改信息

13.1.3 调用方

13.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

scope

Request

String

0...1

排行范围,1:周榜,2:月榜,其他:总榜

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

booksShareInfoList

Response

List

1

图书分享排行列表

BooksShareInfo

booksShareInfoList

BooksShareInfo

0...N

图书分享信息

bookId

BooksShareInfo

String

1

图书Id

shareSum

BooksShareInfo

String

1

分享次数

13.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.1.6 报文样例

请求方法

 
POST /portalapi/getBooksShareRankList

请求报文

 
<Request>
    <scope>3</scope>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <booksShareInfoList>
        <BooksShareInfo>
            <bookId>137478205</bookId>
            <shareSum>1000</shareSum>
        </BooksShareInfo>
        <BooksShareInfo>
            <bookId>137478269</bookId>
            <shareSum>100</shareSum>
        </BooksShareInfo>
    </booksShareInfoList>
</Response>
 

13.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

13.2 getPersonsShareRankList 获取分享达人排行列表接口

13.2.1 接口描述

根据查询范围(周榜,月榜,总榜),查询用户分享的图书数量,并按照分享的数量倒序输出,snswap缓存中使用

13.2.2 最后修改信息

13.2.3 调用方

13.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

scope

Request

String

0...1

排行范围,1:周榜,2:月榜,其他:总榜

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

personsShareInfoList

Response

List

1

分享达人排行列表

PersonsShareInfo

personsShareInfoList

PersonsShareInfo

0...N

分享达人排行列表

mobile

PersonsShareInfo

String

1

手机号

shareSum

PersonsShareInfo

String

1

分享数

newsharebook

PersonsShareInfo

String

1

最近分享图书Id

newsharereason

PersonsShareInfo

String

1

最近分享图书原因

13.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.2.6 报文样例

请求方法

 
POST /portalapi/getPersonsShareRankList

请求报文

 
<Request>
    <scope>3</scope>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <personsShareInfoList>
        <PersonsShareInfo>
            <mobile>15948418301</mobile>
            <shareSum>3695</shareSum>
            <newsharebook>349367330</newsharebook>
            <newsharereason>分享,分分享享。</newsharereason>
        </PersonsShareInfo>
        <PersonsShareInfo>
            <mobile>18702753908</mobile>
            <shareSum>3154</shareSum>
            <newsharebook>8119521</newsharebook>
            <newsharereason>……</newsharereason>
        </PersonsShareInfo>
    </personsShareInfoList>
</Response>
 

13.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

13.3 getStarAuthorHotBookRank 获取悦读热书榜接口

13.3.1 接口描述

获取悦大使提到图书排行榜,按周、月、总出排行;按书的维度,悦大使提到书的数量降序排序。

13.3.2 最后修改信息

13.3.3 调用方

13.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

scope

Request

String

1

排行范围,1:周榜,2:月榜,其他:总榜

start

Request

String

0...1

分页编号

count

Request

String

0...1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalcount

Response

String

1

总记录数

startAuthorHotBookRankList

Response

List

1

悦大使职业积分排行榜列表

StartAuthorHotBookRankInfo

startAuthorHotBookRankList

StartAuthorScoreRankInfo

0...N

悦大使职业积分对象

refBookId

StartAuthorHotBookRankInfo

String

1

提到书Id

count

StartAuthorHotBookRankInfo

String

1

悦大使提到书次数

13.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.3.6 报文样例

请求方法

 
POST /portalapi/getStarAuthorHotBookRank

请求报文

 
<Request>
    <scope>1</scope>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalcount>100</totalcount>
    <startAuthorHotBookRankList>
        <StartAuthorHotBookRankInfo>
            <refBookId>789</refBookId>
            <count>100</count>
        </StartAuthorHotBookRankInfo>
        <StartAuthorHotBookRankInfo>
            <refBookId>987</refBookId>
            <count>80</count>
        </StartAuthorHotBookRankInfo>
    </startAuthorHotBookRankList>
</Response>
 

13.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

13.4 getStarAuthorScoreRank 获取悦大使职业积分排行榜接口

13.4.1 接口描述

按周、月、总获取悦大使排行榜,按职业积分降序排序。

13.4.2 最后修改信息

13.4.3 调用方

13.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

scope

Request

String

1

排行范围,1:周榜,2:月榜,其他:总榜

start

Request

String

0...1

分页编号

count

Request

String

0...1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalcount

Response

String

1

总记录数

startAuthorScoreRankList

Response

List

1

悦大使职业积分排行榜列表

StartAuthorScoreRankInfo

startAuthorScoreRankList

StartAuthorScoreRankInfo

0...N

悦大使职业积分对象

msisdn

StartAuthorScoreRankInfo

String

1

悦大使手机号

score

StartAuthorScoreRankInfo

String

1

悦大使职业积分

13.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.4.6 报文样例

请求方法

 
POST /portalapi/getStarAuthorScoreRank

请求报文

 
<Request>
    <scope>1</scope>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalcount>100</totalcount>
    <startAuthorScoreRankList>
        <StartAuthorScoreRankInfo>
            <msisdn>15077870000</msisdn>
            <score>10000</score>
        </StartAuthorScoreRankInfo>
        <StartAuthorScoreRankInfo>
            <msisdn>15077870001</msisdn>
            <score>8000</score>
        </StartAuthorScoreRankInfo>
    </startAuthorScoreRankList>
</Response>
 

13.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

13.5 getStarAuthorShareBookRank 获取悦读分享榜接口

13.5.1 接口描述

获取悦大使分享图书排行,按周、月、总出排行;按悦大使的维度,分享图书的数量降序排序。

13.5.2 最后修改信息

13.5.3 调用方

13.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

scope

Request

String

1

排行范围,1:周榜,2:月榜,其他:总榜

start

Request

String

0...1

分页编号

count

Request

String

0...1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalcount

Response

String

1

总记录数

startAuthorShareBookRankList

Response

List

1

悦大使分享图书排行榜列表

StartAuthorShareBookRankInfo

startAuthorShareBookRankList

StartAuthorScoreRankInfo

0...N

悦大使分享图书对象

msisdn

StartAuthorShareBookRankInfo

String

1

悦大使手机号

count

StartAuthorShareBookRankInfo

String

1

分享图书数量

13.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.5.6 报文样例

请求方法

 
POST /portalapi/getStarAuthorShareBookRank

请求报文

 
<Request>
    <scope>1</scope>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalcount>100</totalcount>
    <startAuthorShareBookRankList>
        <StartAuthorShareBookRankInfo>
            <msisdn>15077870000</msisdn>
            <count>10000</count>
        </StartAuthorShareBookRankInfo>
        <StartAuthorShareBookRankInfo>
            <msisdn>15077870001</msisdn>
            <count>8000</count>
        </StartAuthorShareBookRankInfo>
    </startAuthorShareBookRankList>
</Response>
 

13.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

13.6 getSubjectRankList 查询主题分享排行列表

13.6.1 接口描述

根据图书Id列表查询主题分享排行列表,在主题分享图书排行标签和snswap缓存中使用

13.6.2 最后修改信息

13.6.3 调用方

13.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bookIdList

Request

List

1

图书Id列表

string

bookIdList

String

0...N

图书Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

ranklist

Response

List

1

图书分享信息列表

BooksShareInfo

ranklist

BooksShareInfo

1...N

图书分享信息

bookId

BooksShareInfo

String

1

图书Id

shareSum

BooksShareInfo

String

1

图书分享数

13.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

13.6.6 报文样例

请求方法

 
POST /portalapi/getSubjectRankList

请求报文

 
<Request>
    <bookIdList>
        <string>137478269</string>
        <string>137478205</string>
    </bookIdList>
</Request>
 

响应报文

  
<Response>
    <ranklist>
        <BooksShareInfo>
            <bookId>137478269</bookId>
            <shareSum>100</shareSum>
        </BooksShareInfo>
        <BooksShareInfo>
            <bookId>137478205</bookId>
            <shareSum>1000</shareSum>
        </BooksShareInfo>
    </ranklist>
</Response>
 

13.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

14 晒书单

14.1 createBookCatalog 添加书目接口

14.1.1 接口描述

用户添加书目

14.1.2 最后修改信息

14.1.3 调用方

14.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookid

Request

String

1

图书id

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书目创建成功

14.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.1.6 报文样例

请求方法

 
POST /portalapi/createBookCatalog

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <bookid>114524</bookid>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.1.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500510

图书ID为空

500511

创建书目异常

500513

创建书目超出最大限制

500523

该书目已经存在

14.2 createBookSheet 创建书单接口

14.2.1 接口描述

用户创建书单

14.2.2 最后修改信息

14.2.3 调用方

14.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

title

Request

String

1

书单标题

msisdn

Request

String

1

阅读号

desc

Request

String

0...1

书单描述

bookid

Request

String

0...1

图书ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Response

String

1

书单id

14.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.2.6 报文样例

请求方法

 
POST /portalapi/createBookSheet

请求报文

 
<Request>
    <title>标题</title>
    <msisdn>13712345678</msisdn>
    <desc>描述</desc>
    <bookid>1000</bookid>
</Request>
 

响应报文

  
<Response>
    <sheetid>1</sheetid>
</Response>
 

14.2.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500502

书单标题为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500506

用户创建书单个数已达到上限

500507

书单ID为空

500511

创建书目异常

500513

创建书目超出最大限制

500523

该书目已经存在

14.3 deleteBookCatalog 删除书目接口

14.3.1 接口描述

用户删除书目

14.3.2 最后修改信息

14.3.3 调用方

14.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

bookid

Request

String

1

图书id

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书目删除成功

14.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.3.6 报文样例

请求方法

 
POST /portalapi/deleteBookCatalog

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <bookid>114524</bookid>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.3.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500510

图书ID为空

500512

删除书目异常

14.4 deleteBookSheet 删除书单接口

14.4.1 接口描述

用户删除书单

14.4.2 最后修改信息

14.4.3 调用方

14.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单删除成功

14.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.4.6 报文样例

请求方法

 
POST /portalapi/deleteBookSheet

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.4.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500509

删除书单异常

14.5 deleteShareBookSheet 删除分享书单接口

14.5.1 接口描述

用户删除分享书单

14.5.2 最后修改信息

14.5.3 调用方

14.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单ID

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单删除分享成功

14.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.5.6 报文样例

请求方法

 
POST /portalapi/deleteShareBookSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.5.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500522

书单删除分享异常

14.6 getBookCatalogsByUser 获取用户某书单下书目列表接口

14.6.1 接口描述

根据手机号查询用户某书单下所有书目信息列表

14.6.2 最后修改信息

14.6.3 调用方

14.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

sheetid

Request

String

1

书单ID

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1分享时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

catalogList

Response

List

0...1

书目列表

BookCatalogInfo

catalogList

BookCatalogInfo

1...N

书目信息

sheetid

BookCatalogInfo

String

1

关联的书单Id

catalogid

BookCatalogInfo

String

1

书目ID

bookid

BookCatalogInfo

String

1

图书ID

permission

BookCatalogInfo

String

1

书目隐私状态 0:公开 1:仅自己可见

status

BookCatalogInfo

String

1

书目状态 0:正常 1:删除

addtime

BookCatalogInfo

String

1

书目添加时间 yyyyMMddHHmmss

14.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.6.6 报文样例

请求方法

 
POST /portalapi/getBookCatalogsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <sheetid>1</sheetid>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <catalogList>
        <BookCatalogInfo>
            <sheetid>3000739</sheetid>
            <catalogid>2</catalogid>
            <bookid>124</bookid>
            <permission>1</permission>
            <status>0</status>
            <addtime>20130930152040</addtime>
        </BookCatalogInfo>
        <BookCatalogInfo>
            <sheetid>3000738</sheetid>
            <catalogid>135</catalogid>
            <bookid>111</bookid>
            <permission>0</permission>
            <status>0</status>
            <addtime>20130930152050</addtime>
        </BookCatalogInfo>
    </catalogList>
</Response>
 

14.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500514

隐私值为空

500518

隐私值非法

14.7 getBookSheetInfo 获取书单信息详情接口

14.7.1 接口描述

根据书单ID查询书单详情信息

14.7.2 最后修改信息

14.7.3 调用方

14.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetInfo

Response

BookSheetInfo

0...1

书单信息

sheetid

sheetInfo

String

1

书单Id

msisdn

sheetInfo

String

1

阅读号

title

sheetInfo

String

1

书单标题

sheetdesc

sheetInfo

String

0...1

书单描述

sharenum

sheetInfo

String

1

书单分享次数

booknum

sheetInfo

String

1

书单书目个数

permission

sheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

sheetInfo

String

1

书单状态 0:正常 1:删除

createtime

sheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

14.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.7.6 报文样例

请求方法

 
POST /portalapi/getBookSheetInfo

请求报文

 
<Request>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <sheetInfo>
        <sheetid>3000739</sheetid>
        <msisdn>15077870000</msisdn>
        <title>书单一</title>
        <sheetdesc>书单一的描述</sheetdesc>
        <sharenum>0</sharenum>
        <booknum>3</booknum>
        <permission>1</permission>
        <status>0</status>
        <createtime>20130930152040</createtime>
    </sheetInfo>
</Response>
 

14.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

500507

书单ID为空

500516

书单ID非法

14.8 getBookSheetsByUser 获取用户书单列表接口

14.8.1 接口描述

根据手机号查询用户的所有书单信息

14.8.2 最后修改信息

14.8.3 调用方

14.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1创建时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

Integer

1

总记录数

sheetList

Response

List

0...1

书单列表

BookSheetInfo

sheetList

BookSheetInfo

1...N

书单信息

sheetid

BookSheetInfo

String

1

书单Id

msisdn

BookSheetInfo

String

1

阅读号

title

BookSheetInfo

String

1

书单标题

sheetdesc

BookSheetInfo

String

0...1

书单描述

sharenum

BookSheetInfo

String

1

书单分享次数

booknum

BookSheetInfo

String

1

书单书目个数

permission

BookSheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

BookSheetInfo

String

1

书单状态 0:正常 1:删除

createtime

BookSheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

14.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.8.6 报文样例

请求方法

 
POST /portalapi/getBookSheetsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <sheetList>
        <BookSheetInfo>
            <sheetid>3000739</sheetid>
            <msisdn>15077870000</msisdn>
            <title>书单一</title>
            <sheetdesc>书单一的描述</sheetdesc>
            <sharenum>0</sharenum>
            <booknum>3</booknum>
            <permission>1</permission>
            <status>0</status>
            <createtime>20130930152040</createtime>
        </BookSheetInfo>
        <BookSheetInfo>
            <sheetid>3000738</sheetid>
            <msisdn>13588164850</msisdn>
            <title>书单二</title>
            <sheetdesc></sheetdesc>
            <sharenum>11</sharenum>
            <booknum>4</booknum>
            <permission>0</permission>
            <status>0</status>
            <createtime>20130930152050</createtime>
        </BookSheetInfo>
    </sheetList>
</Response>
 

14.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500514

隐私值为空

500518

隐私值非法

14.9 getShareBookSheetsByUser 获取用户分享的书单列表接口

14.9.1 接口描述

根据手机号查询用户分享的所有书单信息

14.9.2 最后修改信息

14.9.3 调用方

14.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

ordertype

Request

String

0...1

排序类型-1分享时间2-分享次数3-标题拼音字母4-书目个数,默认时间

sorttype

Request

String

0...1

排序方式:1正序2倒序,默认倒序

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

sheetList

Response

List

0...1

分享的书单列表

BookSheetInfo

sheetList

BookSheetInfo

1...N

书单信息

sheetid

BookSheetInfo

String

1

书单Id

msisdn

BookSheetInfo

String

1

阅读号

title

BookSheetInfo

String

1

书单标题

sheetdesc

BookSheetInfo

String

0...1

书单描述

sharenum

BookSheetInfo

String

1

书单分享次数

booknum

BookSheetInfo

String

1

书单书目个数

permission

BookSheetInfo

String

1

书单隐私状态 0:公开 1:仅自己可见

status

BookSheetInfo

String

1

书单状态 0:正常 1:删除

createtime

BookSheetInfo

String

1

书单创建时间 yyyyMMddHHmmss

14.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.9.6 报文样例

请求方法

 
POST /portalapi/getShareBookSheetsByUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <permission>0</permission>
    <ordertype>0</ordertype>
    <sorttype>1</sorttype>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <sheetList>
        <BookSheetInfo>
            <sheetid>3000739</sheetid>
            <msisdn>15077870000</msisdn>
            <title>书单一</title>
            <sheetdesc>书单一的描述</sheetdesc>
            <sharenum>0</sharenum>
            <booknum>3</booknum>
            <permission>1</permission>
            <status>0</status>
            <createtime>20130930152040</createtime>
        </BookSheetInfo>
        <BookSheetInfo>
            <sheetid>3000738</sheetid>
            <msisdn>13588164850</msisdn>
            <title>书单二</title>
            <sheetdesc></sheetdesc>
            <sharenum>11</sharenum>
            <booknum>4</booknum>
            <permission>0</permission>
            <status>0</status>
            <createtime>20130930152050</createtime>
        </BookSheetInfo>
    </sheetList>
</Response>
 

14.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

500501

阅读号为空

500503

阅读号输入错误

500514

隐私值为空

500518

隐私值非法

14.10 modifyBookSheet 修改书单接口

14.10.1 接口描述

用户修改书单信息

14.10.2 最后修改信息

14.10.3 调用方

14.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

title

Request

String

1

书单标题

msisdn

Request

String

1

阅读号

desc

Request

String

0...1

书单描述

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单修改成功

14.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.10.6 报文样例

请求方法

 
POST /portalapi/modifyBookSheet

请求报文

 
<Request>
    <title>标题</title>
    <msisdn>13712345678</msisdn>
    <desc>描述</desc>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.10.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500502

书单标题为空

500503

阅读号输入错误

500504

书单标题超过长度限制

500505

书单描述超过长度限制

500507

书单ID为空

500516

书单ID非法

500508

阅读号和书单ID不匹配,修改失败

14.11 setBookCatalogPermission 书目隐私设置接口

14.11.1 接口描述

用户设置书目隐私状态

14.11.2 最后修改信息

14.11.3 调用方

14.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

sheetid

Request

String

1

书单id

catalogid

Request

String

1

书目id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书目隐私状态设置成功

14.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.11.6 报文样例

请求方法

 
POST /portalapi/setBookCatalogPermission

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <permission>1</permission>
    <sheetid>1</sheetid>
    <catalogid>1</catalogid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.11.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500520

书目ID为空

500517

书目ID非法

500514

隐私值为空

500518

隐私值非法

500515

更新隐私值异常

14.12 setBookSheetPermission 书单隐私设置接口

14.12.1 接口描述

用户设置书单隐私状态

14.12.2 最后修改信息

14.12.3 调用方

14.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

permission

Request

String

1

隐私值

sheetid

Request

String

1

书单id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单隐私状态设置成功

14.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.12.6 报文样例

请求方法

 
POST /portalapi/setBookSheetPermission

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
    <permission>1</permission>
    <sheetid>1</sheetid>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.12.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500514

隐私值为空

500518

隐私值非法

500515

更新隐私值异常

14.13 shareBookSheet 分享书单接口

14.13.1 接口描述

用户分享书单

14.13.2 最后修改信息

14.13.3 调用方

14.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

sheetid

Request

String

1

书单ID

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultcode

Response

String

1

书单分享成功

14.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

14.13.6 报文样例

请求方法

 
POST /portalapi/shareBookSheet

请求报文

 
<Request>
    <sheetid>1</sheetid>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

  
<Response>
    <resultcode>200</resultcode>
</Response>
 

14.13.7 接口响应码

响应码

描述

2000

其他错误

500501

阅读号为空

500503

阅读号输入错误

500507

书单ID为空

500516

书单ID非法

500521

书单分享异常

15 用户同步

15.1 getUserMemberByName 根据用户名查询会员信息接口

15.1.1 接口描述

根据用户名称查询会员信息。在操作结果标签中使用

15.1.2 最后修改信息

15.1.3 调用方

15.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

userName

Request

String

1

用户名

响应消息体

字段名

父字段名

字段类型

出现次数

描述

userMember

Response

userMember

0...1

用户信息

memberId

userMember

String

1

用户Id

userName

userMember

String

1

用户名

passWord

userMember

String

1

密码

adminId

userMember

String

1

管理组编号

lastpost

userMember

String

0...1

最后一次发帖时间

posts

userMember

String

1

发帖总数

digestPosts

userMember

String

1

精华帖

credits

userMember

String

1

评分

extcredits1

userMember

String

1

积分

extcredits2

userMember

String

1

威望

extcredits3

userMember

String

1

金钱

extcredits4

userMember

String

1

预留字段

extcredits5

userMember

String

1

预留字段

extcredits6

userMember

String

1

预留字段

extcredits7

userMember

String

1

预留字段

extcredits8

userMember

String

1

预留字段

15.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

15.1.6 报文样例

请求方法

 
POST /portalapi/getUserMemberByName

请求报文

 
<Request>
    <userName>15867128196</userName>
</Request>
 

响应报文

  
<Response>
    <userMember>
        <memberId>415</memberId>
        <userName>15867128196</userName>
        <passWord>7b6d3ad8b1f687e42be32e6aaad81445164b811f</passWord>
        <adminId>0</adminId>
        <lastpost></lastpost>
        <posts>0</posts>
        <digestPosts>0</digestPosts>
        <credits>0</credits>
        <extcredits1>0</extcredits1>
        <extcredits2>0</extcredits2>
        <extcredits3>0</extcredits3>
        <extcredits4>0</extcredits4>
        <extcredits5>0</extcredits5>
        <extcredits6>0</extcredits6>
        <extcredits7>0</extcredits7>
        <extcredits8>0</extcredits8>
    </userMember>
</Response>
 

15.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3600

通过会员名查询会员失败

4151

会员名称为空

15.2 getUserMemberExtByMemberId 通过用户信息Id查询用户扩展信息接口

15.2.1 接口描述

通过用户信息Id查询用户扩展信息。在操作结果标签中使用

15.2.2 最后修改信息

15.2.3 调用方

15.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

memberId

Request

String

1

用户信息Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

userMemberExt

Response

membersExtId

userMemberExt

String

1

扩展用户信息Id

userId

userMemberExt

String

1

用户Id

nickName

userMemberExt

String

0...1

昵称

mobile

userMemberExt

String

1

手机号

userAgent

userMemberExt

String

0...1

型号终端

notes

userMemberExt

String

0...1

用户说明

age

userMemberExt

String

0...1

年龄

sex

userMemberExt

String

0...1

性别(0:男,1:女 -1:保密)

provinceId

userMemberExt

String

0...1

省份编码

userPassword

userMemberExt

String

0...1

密码

question

userMemberExt

String

0...1

取回密码问题

answer

userMemberExt

String

0...1

取回密码答案

cityId

userMemberExt

String

0...1

地市编码

signature

userMemberExt

String

0...1

用户签名

interest

userMemberExt

String

0...1

爱好

firstPageId

userMemberExt

String

0...1

用户登录进入页面的编码存放用户登录进入页面的编码(0:书城,1:书吧,2:书房)

lastOnlineDate

userMemberExt

String

0...1

用户最后鉴权时间

activeDate

userMemberExt

String

0...1

用户激活日期

userName

userMemberExt

String

0...1

用户姓名

idCard

userMemberExt

String

0...1

用户身份证号码

userState

userMemberExt

String

0...1

用户当前状态(DEFAULT 0) 0:正常 1:暂停 2:停机 3:欠费 4:黑名单不能登录 5:待激活用户 6:黑名单不能使用 9 已注销

address

userMemberExt

String

0...1

用户地址

zipcode

userMemberExt

String

0...1

用户邮政编码

homePhone

userMemberExt

String

0...1

用户家庭电话号码

officePhone

userMemberExt

String

0...1

用户办公室电话

faxPhone

userMemberExt

String

0...1

用户传真

loginDate

userMemberExt

String

0...1

用户注册时间

email

userMemberExt

String

0...1

用户Email

roleId

userMemberExt

String

0...1

用户角色(0:普通用户 1:测试用户2:管理员)

pageWordCount

userMemberExt

String

0...1

分页字数

headId

userMemberExt

String

0...1

头像标识

descriptionInfo

userMemberExt

String

0...1

描述

gradeId

userMemberExt

String

0...1

级别编码

clientVersion

userMemberExt

String

0...1

客户端版本

clientChannel

userMemberExt

String

0...1

客户端下载渠道

flux

userMemberExt

String

0...1

是否收取流量费(是否收取流量费;0:不收取,1:收取)

bookChapterOrderType

userMemberExt

cityName

userMemberExt

String

0...1

所在城市名

firstPurchase

userMemberExt

String

0...1

industryId

userMemberExt

String

0...1

isIndustryUserFlag

userMemberExt

String

0...1

isMember

userMemberExt

String

0...1

onlineState

userMemberExt

String

0...1

provinceGrade

userMemberExt

String

0...1

provinceName

userMemberExt

String

0...1

所在省名称

scheduleUpdate

userMemberExt

String

0...1

subscribeRemind

userMemberExt

String

0...1

syncTime

userMemberExt

String

0...1

同步信息时间

userMemberId

userMemberExt

String

1

用户信息Id

15.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

15.2.6 报文样例

请求方法

 
POST /portalapi/getUserMemberExtByMemberId

请求报文

 
<Request>
    <memberId>2006127</memberId>
</Request>
 

响应报文

  
<Response>
    <userMemberExt>
        <membersExtId>2005299</membersExtId>
        <userId>1</userId>
        <nickName></nickName>
        <mobile>15077870000</mobile>
        <userAgent></userAgent>
        <notes></notes>
        <age></age>
        <sex></sex>
        <provinceId></provinceId>
        <userPassword></userPassword>
        <question></question>
        <answer></answer>
        <cityId></cityId>
        <signature></signature>
        <interest></interest>
        <firstPageId></firstPageId>
        <lastOnlineDate></lastOnlineDate>
        <activeDate></activeDate>
        <userName></userName>
        <idCard></idCard>
        <userState></userState>
        <address></address>
        <zipcode></zipcode>
        <homePhone></homePhone>
        <officePhone></officePhone>
        <faxPhone></faxPhone>
        <loginDate></loginDate>
        <email></email>
        <roleId></roleId>
        <pageWordCount></pageWordCount>
        <headId></headId>
        <descriptionInfo></descriptionInfo>
        <gradeId></gradeId>
        <clientVersion></clientVersion>
        <clientChannel></clientChannel>
        <flux></flux>
        <bookChapterOrderType></bookChapterOrderType>
        <cityName></cityName>
        <firstPurchase></firstPurchase>
        <industryId></industryId>
        <isIndustryUserFlag></isIndustryUserFlag>
        <isMember></isMember>
        <onlineState></onlineState>
        <provinceGrade></provinceGrade>
        <provinceName></provinceName>
        <scheduleUpdate></scheduleUpdate>
        <subscribeRemind></subscribeRemind>
        <syncTime></syncTime>
        <userMemberId>2006127</userMemberId>
    </userMemberExt>
</Response>
 

15.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3604

通过会员编号查询扩展用户信息失败

4153

会员名称为空

16 直播间

16.1 addLiveMsg 新增用户直播间留言接口

16.1.1 接口描述

新增用户直播间留言,在用户留言回复标签和发表留言标签和话题留言回复结果标签和中使用

16.1.2 最后修改信息

16.1.3 调用方

16.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

roomId

Request

String

1

直播间ID

niceName

Request

String

0...1

昵称

topicId

Request

String

0...1

话题ID

messageContent

Request

String

1

留言内容

floors

Request

String

1

楼层

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.1.6 报文样例

请求方法

 
POST /portalapi/addLiveMsg

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <roomId>157</roomId>
    <niceName></niceName>
    <topicId></topicId>
    <messageContent>太闹心</messageContent>
    <floors>1</floors>
</Request>
 

响应报文

  
 

16.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3001

直播间信息不存在

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4009

直播间ID为空

4010

直播间ID为非数字

4013

留言内容为空

4146

楼层为非数字

4147

楼层为空

4148

留言间隔时间少于直播间间隔时间

16.2 addReserve 一键预定直播接口

16.2.1 接口描述

用户一键预定直播,在一键预定链接标签中使用

16.2.2 最后修改信息

16.2.3 调用方

16.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

userName

Request

String

1

用户名

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.2.6 报文样例

请求方法

 
POST /portalapi/addReserve

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <userName>zmren</userName>
</Request>
 

响应报文

  
 

16.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4165

用户名不能为空

16.3 cancelReserve 一键取消预定直播接口

16.3.1 接口描述

用户一键取消预定直播,在一键预定取消标签中使用

16.3.2 最后修改信息

16.3.3 调用方

16.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

userName

Request

String

1

用户名

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.3.6 报文样例

请求方法

 
POST /portalapi/cancelReserve

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <userName>zmren</userName>
</Request>
 

响应报文

  
 

16.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4165

用户名不能为空

16.4 getAllLiveMsg 查询直播间留言接口

16.4.1 接口描述

查询直播间留言或话题留言按时间降序,过滤掉状态为先审后发(未审核)和已删除和已屏蔽的留言,在留言列表标签和话题标签中使用

16.4.2 最后修改信息

16.4.3 调用方

16.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

start

Request

String

1

分页编号

count

Request

String

1

分页长度

order

Request

String

1

排序方式,0:正序,其他:倒叙

topicId

Request

String

0...1

话题ID,查询话题留言时必填

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveMessageList

Response

List

1

留言列表

LiveMessage

liveMessageList

LiveMessage

0...N

留言信息

roomId

LiveMessage

String

1

直播间ID

messageTime

LiveMessage

String

1

留言时间

mobile

LiveMessage

String

1

用户手机号

niceName

LiveMessage

String

1

昵称

userArea

LiveMessage

String

0...1

用户归属地,话题留言时才返回

messageContent

LiveMessage

String

1

用户留言内容

memberId

LiveMessage

String

1

审核人员ID

messageState

LiveMessage

String

1

留言状态,0:先审后发(未审核)1:已删除、2:已屏蔽、3:先发后审、4:审核通过

topicId

LiveMessage

String

0...1

话题ID,话题留言时才返回

displayOrder

LiveMessage

String

1

是否置顶,0:否、1:

digest

LiveMessage

String

1

是否加精,0:否、1:

floors

LiveMessage

String

1

楼层

messsageId

LiveMessage

String

0...1

留言ID,非话题留言才返回

16.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.4.6 报文样例

请求方法

 
POST /portalapi/getAllLiveMsg

请求报文

 
<Request>
    <roomId>151</roomId>
    <start>0</start>
    <count>0</count>
    <order>0</order>
    <topicId>142</topicId>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveMessageList>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514215017</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>喊破喉咙也没用的</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <topicId>142</topicId>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>2</floors>
            <messsageId></messsageId>
        </LiveMessage>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514214713</messageTime>
            <mobile>13630620000</mobile>
            <niceName>136****0000</niceName>
            <userArea>吉林吉林</userArea>
            <messageContent>助けてくれ!</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
            <topicId>142</topicId>
            <displayOrder>0</displayOrder>
            <digest>0</digest>
            <floors>1</floors>
            <messsageId></messsageId>
        </LiveMessage>
    </liveMessageList>
</Response>
 

16.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4009

直播间ID为空

4010

直播间ID为非数字

4014

排序为空

4027

排序为非数字

16.5 getAllLiveSpeakMsg 查看主持人和嘉宾直播聊天记录接口

16.5.1 接口描述

查看主持人和嘉宾直播聊天记录,在主持人嘉宾直播详情标签中使用

16.5.2 最后修改信息

16.5.3 调用方

16.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

start

Request

String

1

分页编号

count

Request

String

1

分页长度

order

Request

String

1

排序方式,0:正序,其他:倒叙

standard

Request

String

1

直播间图片规格,1:3w规格,其他:wap规格

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveSpeakMsgList

Response

List

1

主持人和嘉宾的留言列表

LiveSpeakMsg

liveSpeakMsgList

LiveSpeakMsg

0...N

留言信息

roomId

LiveSpeakMsg

String

1

直播间ID

createTime

LiveSpeakMsg

String

1

留言时间

speakContent

LiveSpeakMsg

String

1

留言内容

speakerid

LiveSpeakMsg

String

1

嘉宾或主持人的留言ID

16.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.5.6 报文样例

请求方法

 
POST /portalapi/getAllLiveSpeakMsg

请求报文

 
<Request>
    <roomId>151</roomId>
    <start>0</start>
    <count>0</count>
    <order>0</order>
    <standard>0</standard>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveSpeakMsgList>
        <LiveSpeakMsg>
            <roomId>151</roomId>
            <createTime>20120510164727</createTime>
            <speakContent>r00201728:开张了</speakContent>
            <speakerid>6631</speakerid>
        </LiveSpeakMsg>
        <LiveSpeakMsg>
            <roomId>151</roomId>
            <createTime>20120510165727</createTime>
            <speakContent>r00201728:木有人呢</speakContent>
            <speakerid>6631</speakerid>
        </LiveSpeakMsg>
    </liveSpeakMsgList>
</Response>
 

16.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4009

直播间ID为空

4010

直播间ID为非数字

4014

排序为空

4027

排序为非数字

4139

直播间图片规格为空

4140

直播间图片规格为非数字

16.6 getLiveMessageByMessageId 获取直播间留言详情

16.6.1 接口描述

获取直播间留言详情,话题留言回复标签和用户留言回复标签使用

16.6.2 最后修改信息

16.6.3 调用方

16.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

messageId

Request

String

1

留言Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

liveMsgInfo

Response

messageTime

liveMsgInfo

String

1

发表留言时间

mobile

liveMsgInfo

String

1

用户手机号

niceName

liveMsgInfo

String

0...1

用户昵称

messageContent

liveMsgInfo

String

1

留言内容

16.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.6.6 报文样例

请求方法

 
POST /portalapi/getLiveMessageByMessageId

请求报文

 
<Request>
    <messageId>1119</messageId>
</Request>
 

响应报文

  
<Response>
    <liveMsgInfo>
        <messageTime>20110323134633</messageTime>
        <mobile>13484122424</mobile>
        <niceName>134****2424</niceName>
        <messageContent>三叔,盗过墓?</messageContent>
    </liveMsgInfo>
</Response>
 

16.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4206

留言ID为空

4207

留言ID应为整型

4208

无此留言信息

16.7 getLiveRoomInfo 获取直播间信息

16.7.1 接口描述

获取直播间信息

16.7.2 最后修改信息

16.7.3 调用方

16.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

liveRoom

Response

liveRoom

1

直播间信息

roomId

liveRoom

String

1

直播间ID

roomName

liveRoom

String

1

直播间名称

roomState

liveRoom

String

1

直播间状态,1: 直播中、2: 预定、3: 历史、4: 暂时关闭

beginTime

liveRoom

String

1

直播开始时间

endTime

liveRoom

String

1

直播结束时间

nodeId

liveRoom

String

1

直播间节点ID

roleList

liveRoom

List

1

直播间角色列表

LiveRole

roleList

LiveRoleInfo

1...N

直播间角色信息

roleId

LiveRole

String

1

角色ID

roleName

LiveRole

String

1

角色名字

mobile

LiveRole

String

1

角色手机号

roleEmail

LiveRole

String

1

角色email

roleState

LiveRole

String

1

角色类型,3:主持人,4:嘉宾

16.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.7.6 报文样例

请求方法

 
POST /portalapi/getLiveRoomInfo

请求报文

 
<Request>
    <roomId>157</roomId>
</Request>
 

响应报文

  
<Response>
    <liveRoom>
        <roomId>157</roomId>
        <roomName>任工的小单间</roomName>
        <roomState>2</roomState>
        <beginTime>20120520160009</beginTime>
        <endTime>20120526160015</endTime>
        <nodeId>94</nodeId>
        <roleList>
            <LiveRole>
                <roleId>185</roleId>
                <roleName>郭敬明</roleName>
                <mobile>13968141949</mobile>
                <roleEmail>13968141949@139.com</roleEmail>
                <roleState>4</roleState>
            </LiveRole>
            <LiveRole>
                <roleId>545</roleId>
                <roleName>r00201728</roleName>
                <mobile>15077870000</mobile>
                <roleEmail>renzhimin@huawei.com</roleEmail>
                <roleState>3</roleState>
            </LiveRole>
        </roleList>
    </liveRoom>
</Response>
 

16.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3001

直播间信息不存在

4009

直播间ID为空

4010

直播间ID为非数字

16.8 getLiveSpeakContent 查询直播间主持人或嘉宾的留言内容接口

16.8.1 接口描述

查询直播间主持人或嘉宾的留言内容,在主持人嘉宾发言转发理由标签中使用

16.8.2 最后修改信息

16.8.3 调用方

16.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

speakerid

Request

String

1

主持人或嘉宾的留言Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

speakcontent

Response

String

0...1

主持人或嘉宾的留言内容

16.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.8.6 报文样例

请求方法

 
POST /portalapi/getLiveSpeakContent

请求报文

 
<Request>
    <speakerid>6631</speakerid>
</Request>
 

响应报文

  
<Response>
    <speakcontent>r00201728:开张了</speakcontent>
</Response>
 

16.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

16.9 getLiveToastmaster 查询主持人信息列表接口

16.9.1 接口描述

查询主持人信息列表,有bug,总数只查主持人,但列表查的是嘉宾和主持人,在主持节目列表标签和金牌主播标签中使用

16.9.2 最后修改信息

16.9.3 调用方

16.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

emceeIdList

Request

liveRoom

0...1

主持人Id,多个Id以逗号分隔

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

roleList

Response

List

1

主持人信息列表

LiveRole

roleList

LiveRole

0...N

积分兑换规则项

roleId

LiveRole

String

1

主持人ID

roleName

LiveRole

String

1

主持人名字

mobile

LiveRole

String

1

主持人手机号

roleEmail

LiveRole

String

1

主持人email

roleState

LiveRole

String

1

角色标识,3:主持人、4:嘉宾

16.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.9.6 报文样例

请求方法

 
POST /portalapi/getLiveToastmaster

请求报文

 
<Request>
    <emceeIdList></emceeIdList>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <roleList>
        <LiveRole>
            <roleId>1</roleId>
            <roleName>hd0001</roleName>
            <mobile>13111111111</mobile>
            <roleEmail>hd0001@cmread.com</roleEmail>
            <roleState>3</roleState>
        </LiveRole>
        <LiveRole>
            <roleId>83</roleId>
            <roleName>hd0002</roleName>
            <mobile>13111111111</mobile>
            <roleEmail>hd0002@cmread.com</roleEmail>
            <roleState>3</roleState>
        </LiveRole>
        <LiveRole>
            <roleId>84</roleId>
            <roleName>hd0003</roleName>
            <mobile>13111111111</mobile>
            <roleEmail>hd0003@cmread.com</roleEmail>
            <roleState>4</roleState>
        </LiveRole>
        <LiveRole>
            <roleId>194</roleId>
            <roleName>张勇</roleName>
            <mobile>13735537691</mobile>
            <roleEmail>caiyiwen1989@163.com</roleEmail>
            <roleState>4</roleState>
        </LiveRole>
    </roleList>
</Response>
 

16.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4028

主持人ID为空

4020

主持人ID为非数字

16.10 getLiveToastmasterRoom 查询嘉宾或主持人参与的直播间接口

16.10.1 接口描述

查询嘉宾或主持人参与的直播间(直播或预定状态或历史直播),在主持节目列表标签中使用

16.10.2 最后修改信息

16.10.3 调用方

16.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roleId

Request

liveRoom

1

角色Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveRoomList

Response

List

1

直播间信息列表

LiveRoom

liveRoomList

LiveRole

0...N

直播间信息

roomId

LiveRoom

String

1

直播间ID

roomName

LiveRoom

String

1

直播间名称

roomState

LiveRoom

String

1

直播间状态,1: 直播中、2: 预定、3: 历史、4: 暂时关闭、5:删除状态

beginTime

LiveRoom

String

1

开始时间

endTime

LiveRoom

String

1

结束时间

nodeId

LiveRoom

String

1

直播大厅ID

16.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.10.6 报文样例

请求方法

 
POST /portalapi/getLiveToastmasterRoom

请求报文

 
<Request>
    <roleId>545</roleId>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <liveRoomList>
        <LiveRoom>
            <roomId>151</roomId>
            <roomName>小黑屋</roomName>
            <roomState>1</roomState>
            <beginTime>20120510150710</beginTime>
            <endTime>20120531150719</endTime>
            <nodeId>94</nodeId>
        </LiveRoom>
        <LiveRoom>
            <roomId>157</roomId>
            <roomName>任工的小单间</roomName>
            <roomState>2</roomState>
            <beginTime>20120520160009</beginTime>
            <endTime>20120526160015</endTime>
            <nodeId>94</nodeId>
        </LiveRoom>
    </liveRoomList>
</Response>
 

16.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4028

主持人ID为空

4020

主持人ID为非数字

16.11 getLiveTopicInfoByTopicId 获取直播间话题详情接口

16.11.1 接口描述

通过话题Id获取直播间话题详情,在话题标签中使用

16.11.2 最后修改信息

16.11.3 调用方

16.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

topicId

Request

String

1

话题Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

topicInfo

Response

topicInfo

0...1

话题信息

topicId

topicInfo

String

1

话题Id

roomId

topicInfo

String

1

直播间Id

topicTitle

topicInfo

String

1

话题标题

topicCreatetime

topicInfo

String

1

话题创建时间

topicCreator

topicInfo

String

1

话题创建者

topicRemark

topicInfo

String

1

话题备注信息

16.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.11.6 报文样例

请求方法

 
POST /portalapi/getLiveTopicInfoByTopicId

请求报文

 
<Request>
    <topicId>142</topicId>
</Request>
 

响应报文

  
<Response>
    <topicInfo>
        <topicId>142</topicId>
        <roomId>151</roomId>
        <topicTitle>午夜鬼话</topicTitle>
        <topicCreatetime>20120514113637</topicCreatetime>
        <topicCreator>r00201728</topicCreator>
        <topicRemark>22</topicRemark>
    </topicInfo>
</Response>
 

16.11.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4203

话题为空

4204

话题ID应为整型

4205

无此话题信息

16.12 getLiveTopicListByRoomId 通过直播间ID获取此直播间所属话题列表信息接口

16.12.1 接口描述

通过直播间ID获取此直播间所属话题列表信息,在话题标签中使用

16.12.2 最后修改信息

16.12.3 调用方

16.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

order

Request

String

1

按话题Id排序,0正序,其他倒序

status

Request

String

1

话题状态,1开启,0关闭

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveTopicInfoList

Response

List

1

话题列表

TopicInfo

liveTopicInfoList

TopicInfo

0...N

话题信息

topicId

TopicInfo

String

1

话题Id

roomId

TopicInfo

String

1

直播间Id

topicTitle

TopicInfo

String

1

话题标题

topicCreatetime

TopicInfo

String

1

话题创建时间

topicCreator

TopicInfo

String

1

话题创建者

topicRemark

TopicInfo

String

1

话题备注信息

topicStatus

TopicInfo

String

1

话题状态,1开启,0关闭

16.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.12.6 报文样例

请求方法

 
POST /portalapi/getLiveTopicListByRoomId

请求报文

 
<Request>
    <roomId>151</roomId>
    <start>0</start>
    <count>0</count>
    <order>0</order>
    <status></status>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveTopicInfoList>
        <TopicInfo>
            <topicId>142</topicId>
            <roomId>151</roomId>
            <topicTitle>午夜鬼话</topicTitle>
            <topicCreatetime>20120514113637</topicCreatetime>
            <topicCreator>r00201728</topicCreator>
            <topicRemark>22</topicRemark>
            <topicStatus>1</topicStatus>
        </TopicInfo>
        <TopicInfo>
            <topicId>161</topicId>
            <roomId>151</roomId>
            <topicTitle>密室杀人事件</topicTitle>
            <topicCreatetime>20120514113942</topicCreatetime>
            <topicCreator>r00201728</topicCreator>
            <topicStatus>1</topicStatus>
        </TopicInfo>
    </liveTopicInfoList>
</Response>
 

16.12.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4009

直播间ID为空

4010

直播间ID为非数字

4014

排序为空

4027

排序为非数字

4015

话题状态为空

4029

话题状态为非数字

16.13 getMyLiveMessage 查询我的直播间留言接口

16.13.1 接口描述

查询我的直播间留言按时间降序,在我的直播间留言列表标签中使用

16.13.2 最后修改信息

16.13.3 调用方

16.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

mobile

Request

String

1

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

order

Request

String

1

排序方式,0:正序,其他:倒叙

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveMessageList

Response

List

1

留言列表

LiveMessage

liveMessageList

LiveMessage

0...N

留言信息

roomId

LiveMessage

String

1

直播间ID

messageTime

LiveMessage

String

1

留言时间

mobile

LiveMessage

String

1

用户手机号

niceName

LiveMessage

String

1

昵称

userArea

LiveMessage

String

0...1

用户归属地,话题留言时才返回

messageContent

LiveMessage

String

1

用户留言内容

memberId

LiveMessage

String

1

审核人员ID

messageState

LiveMessage

String

1

留言状态,0:先审后发(未审核)1:已删除、2:已屏蔽、3:先发后审、4:审核通过

16.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.13.6 报文样例

请求方法

 
POST /portalapi/getMyLiveMessage

请求报文

 
<Request>
    <roomId>151</roomId>
    <mobile>15077870000</mobile>
    <start>0</start>
    <count>0</count>
    <order>0</order>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveMessageList>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514215017</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>喊破喉咙也没用的</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
        </LiveMessage>
        <LiveMessage>
            <roomId>151</roomId>
            <messageTime>20120514222631</messageTime>
            <mobile>15077870000</mobile>
            <niceName>150****0000</niceName>
            <userArea>江苏南京</userArea>
            <messageContent>飘过</messageContent>
            <memberId>793</memberId>
            <messageState>3</messageState>
        </LiveMessage>
    </liveMessageList>
</Response>
 

16.13.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4009

直播间ID为空

4010

直播间ID为非数字

4014

排序为空

4027

排序为非数字

16.14 getReserveRoom 获取需要预订的直播间列表接口

16.14.1 接口描述

该接口实现用户一键预订直播间时,获取符合要求的直播间列表供用户预订,在一键预定标签中使用

16.14.2 最后修改信息

16.14.3 调用方

16.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

无效字段

userName

Request

String

1

无效字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

roomList

Response

List

1

直播间列表

LiveRoom

roomList

LiveRoom

0...N

直播间信息

roomId

LiveRoom

String

1

直播间ID

roomName

LiveRoom

String

1

直播间名称

beginTime

LiveRoom

String

1

直播时间

nodeId

LiveRoom

String

1

直播间节点ID

roleList

LiveRoom

List

1

直播间角色列表

LiveRoleInfo

roleList

LiveRoleInfo

1...N

直播间角色信息

roleId

LiveRoleInfo

String

1

角色ID

roleName

LiveRoleInfo

String

1

角色名字

mobile

LiveRoleInfo

String

1

角色手机号

roleEmail

LiveRoleInfo

String

1

角色email

roleState

LiveRoleInfo

String

1

角色类型,3:主持人,4:嘉宾

16.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.14.6 报文样例

请求方法

 
POST /portalapi/getReserveRoom

请求报文

 
<Request>
    <mobile></mobile>
    <userName></userName>
</Request>
 

响应报文

  
<Response>
    <roomList>
        <LiveRoom>
            <roomId>157</roomId>
            <roomName>任工的小单间</roomName>
            <beginTime>20120520160009</beginTime>
            <nodeId>94</nodeId>
            <roleList>
                <LiveRoleInfo>
                    <roleId>185</roleId>
                    <roleName>郭敬明</roleName>
                    <mobile>13968141949</mobile>
                    <roleEmail>13968141949@139.com</roleEmail>
                    <roleState>4</roleState>
                </LiveRoleInfo>
                <LiveRoleInfo>
                    <roleId>545</roleId>
                    <roleName>r00201728</roleName>
                    <mobile>15077870000</mobile>
                    <roleEmail>renzhimin@huawei.com</roleEmail>
                    <roleState>3</roleState>
                </LiveRoleInfo>
            </roleList>
        </LiveRoom>
        <LiveRoom>
            <roomId>158</roomId>
            <roomName>任工来了</roomName>
            <beginTime>20120521164854</beginTime>
            <nodeId>94</nodeId>
            <roleList>
                <LiveRoleInfo>
                    <roleId>77</roleId>
                    <roleName>树下野狐</roleName>
                    <mobile>13968141949</mobile>
                    <roleEmail>13968141949@139.com</roleEmail>
                    <roleState>4</roleState>
                </LiveRoleInfo>
                <LiveRoleInfo>
                    <roleId>78</roleId>
                    <roleName>狐小妹</roleName>
                    <mobile>13968141949</mobile>
                    <roleEmail>13968141949@139.com</roleEmail>
                    <roleState>4</roleState>
                </LiveRoleInfo>
                <LiveRoleInfo>
                    <roleId>62</roleId>
                    <roleName>abc123</roleName>
                    <mobile>15858268847</mobile>
                    <roleEmail>huangjunfeng@huawei.com</roleEmail>
                    <roleState>3</roleState>
                </LiveRoleInfo>
                <LiveRoleInfo>
                    <roleId>65</roleId>
                    <roleName>蓝雨</roleName>
                    <mobile>13588254927</mobile>
                    <roleEmail>wangyn@cmread.com</roleEmail>
                    <roleState>3</roleState>
                </LiveRoleInfo>
            </roleList>
        </LiveRoom>
    </roomList>
</Response>
 

16.14.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4165

用户名不能为空

16.15 getRoomOnlineSum 获取直播间在线人数接口

16.15.1 接口描述

获取直播间在线人数(java缓存map中获取,缓存默认1分钟更新一次),在线人数标签中使用

16.15.2 最后修改信息

16.15.3 调用方

16.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Request

String

1

直播间ID

响应消息体

字段名

父字段名

字段类型

出现次数

描述

roomId

Response

String

1

直播间ID

onlineSum

Response

String

1

直播间在线人数

16.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.15.6 报文样例

请求方法

 
POST /portalapi/getRoomOnlineSum

请求报文

 
<Request>
    <roomId>151</roomId>
</Request>
 

响应报文

  
<Response>
    <roomId>151</roomId>
    <onlineSum>17</onlineSum>
</Response>
 

16.15.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4009

直播间ID为空

4010

直播间ID为非数字

16.16 hasReserve 判断该用户是否已经一键预订直播间接口

16.16.1 接口描述

判断该用户是否已经一键预订直播间,在一键预订链接标签中使用

16.16.2 最后修改信息

16.16.3 调用方

16.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

userName

Request

String

1

用户名

响应消息体

字段名

父字段名

字段类型

出现次数

描述

reserveFlag

Response

String

1

是否已预订,true/false

16.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.16.6 报文样例

请求方法

 
POST /portalapi/hasReserve

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <userName>zmren</userName>
</Request>
 

响应报文

  
<Response>
    <reserveFlag>true</reserveFlag>
</Response>
 

16.16.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4165

用户名不能为空

16.17 hasReserveAgain 判断是否已经通过一键预订功能预订了此直播间接口

16.17.1 接口描述

判断是否已经通过一键预订功能预订了此直播间,在我要预订链接标签中使用

16.17.2 最后修改信息

16.17.3 调用方

16.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

roomId

Request

String

1

直播间id

sendUrl

Request

String

0...1

无效字段

messageContent

Request

String

0...1

无效字段

niceName

Request

String

0...1

无效字段

hasWholeReserve

Request

String

0...1

无效字段

响应消息体

字段名

父字段名

字段类型

出现次数

描述

reserveFlag

Response

String

1

是否已预订,true/false

16.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.17.6 报文样例

请求方法

 
POST /portalapi/hasReserveAgain

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <roomId>111</roomId>
    <sendUrl></sendUrl>
    <messageContent></messageContent>
    <niceName></niceName>
    <hasWholeReserve></hasWholeReserve>
</Request>
 

响应报文

  
<Response>
    <reserveFlag>true</reserveFlag>
</Response>
 

16.17.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4009

直播间ID为空

4010

直播间ID为非数字

16.18 predictLiveRoom 预订直播间接口

16.18.1 接口描述

预订直播间,在一键预定链接标签和我要预订链接标签中使用

16.18.2 最后修改信息

16.18.3 调用方

16.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

用户手机号

roomId

Request

String

1

直播间ID

sendUrl

Request

String

1

发送直播间url

messageContent

Request

String

1

发送短信息内容

niceName

Request

String

1

昵称

hasWholeReserve

Request

String

1

是否是一键预定,0:不是,1:

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.18.6 报文样例

请求方法

 
POST /portalapi/predictLiveRoom

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <roomId>151</roomId>
    <sendUrl>http://handset.cmread.com:80/sns/wap/p/live/lqzb.jsp?roomId=151</sendUrl>
    <messageContent>哇哈哈</messageContent>
    <niceName>屌丝</niceName>
    <hasWholeReserve>0</hasWholeReserve>
</Request>
 

响应报文

  
 

16.18.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3005

已经预定过了

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4009

直播间ID为空

4010

直播间ID为非数字

4018

发送url为空

4019

发送内容为空

4177

是否是一键预定标识不能为空

4178

是否是一键预定标识不是数字

16.19 refreshOnlineUser 更新直播间在线用户接口

16.19.1 接口描述

更新直播间在线用户,清楚掉65秒内没有活动的用户,wap新进入直播间的用户队列大于最大限制(默认20)或每5分钟调用一次这个接口,wap线程中使用

16.19.2 最后修改信息

16.19.3 调用方

16.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.19.6 报文样例

请求方法

 
POST /portalapi/refreshOnlineUser

请求报文

 
 

响应报文

  
 

16.19.7 接口响应码

响应码

描述

200

成功

2000

程序异常

16.20 roomOnlineUserManager 直播间用户管理接口

16.20.1 接口描述

直播间用户管理,更新用户在线和离线缓存,在在线人数标签中或离开直播间时使用

16.20.2 最后修改信息

16.20.3 调用方

16.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

addRoomOnlineUserStr

Request

String

0...1

进入直播间的用户列表,格式为”房间ID:SessionId:手机号,房间ID:SessionId:手机号“,游客时手机号为空但冒号不能省略, 此字段有最大长度限制4000个字符

delRoomOnlineUserStr

Request

String

0...1

退出直播间的用户列表,格式为”房间ID:SessionId,房间ID:SessionId”,字符串最大取前4000个字符,此字段有最大长度限制4000个字符

响应消息体

字段名

父字段名

字段类型

出现次数

描述

16.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.20.6 报文样例

请求方法

 
POST /portalapi/roomOnlineUserManager

请求报文

 
<Request>
    <addRoomOnlineUserStr>151:CC4331D8D68640D1552782131474CCB1:15077870000,151:CC4331D8D68640D1552782131474CCB2:15077870001</addRoomOnlineUserStr>
    <delRoomOnlineUserStr>151:CC4331D8D68640D1552782131474CCB1,151:CC4331D8D68640D1552782131474CCB2</delRoomOnlineUserStr>
</Request>
 

响应报文

  
 

16.20.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3003

字符串格式错误

3004

sessionID格式错误

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4009

直播间ID为空

4010

直播间ID为非数字

4024

sessionId为空

4070

sessionID长度不足32

16.21 searchLiveRoom 查询直播间信息接口

16.21.1 接口描述

查询直播间信息,支持按时间段查询,按直播间名模糊查询,查询当日直播,过滤掉了直播间状态为4: 暂时关闭、5: 删除状态的房间,在搜索结果标签和直播列表标签和今日直播列表标签中使用

16.21.2 最后修改信息

16.21.3 调用方

16.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

roomState

Request

String

0...1

直播间状态,1: 直播中、2: 预定、3: 历史、6: 当日直播、7: 时间段内直播(7并不填时间时有bug)

startTime

Request

String

0...1

开始时间

endTime

Request

String

0...1

结束时间

name

Request

String

0...1

直播间名称,模糊查询

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

liveRoomList

Response

List

1

直播间信息列表

LiveRoom

liveRoomList

LiveRole

0...N

直播间信息

roomId

LiveRoom

String

1

直播间ID

roomName

LiveRoom

String

1

直播间名称

roomState

LiveRoom

String

1

直播间状态,1: 直播中、2: 预定、3: 历史、4: 暂时关闭、5: 删除状态

beginTime

LiveRoom

String

1

开始时间

endTime

LiveRoom

String

1

结束时间

nodeId

LiveRoom

String

1

直播大厅ID

16.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

16.21.6 报文样例

请求方法

 
POST /portalapi/searchLiveRoom

请求报文

 
<Request>
    <roomState></roomState>
    <startTime></startTime>
    <endTime></endTime>
    <name></name>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <liveRoomList>
        <LiveRoom>
            <roomId>151</roomId>
            <roomName>小黑屋</roomName>
            <roomState>1</roomState>
            <beginTime>20120510150710</beginTime>
            <endTime>20120531150719</endTime>
            <nodeId>94</nodeId>
        </LiveRoom>
        <LiveRoom>
            <roomId>157</roomId>
            <roomName>任工的小单间</roomName>
            <roomState>2</roomState>
            <beginTime>20120520160009</beginTime>
            <endTime>20120526160015</endTime>
            <nodeId>94</nodeId>
        </LiveRoom>
    </liveRoomList>
</Response>
 

16.21.7 接口响应码

响应码

描述

200

成功

2000

程序异常

3002

结束时间大于开始时间

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4021

直播状态为非数字

4022

开始时间格式错误

4023

结束时间格式错误

17 积分经验值等级

17.1 deductIntegral 扣除积分接口

17.1.1 接口描述

互动wap调用此接口进行扣除积分操作

17.1.2 最后修改信息

17.1.3 调用方

17.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号码

integral

Request

String

1

积分数

reason

Request

String

1

扣除说明

portalType

Request

String

1

门户类型:1:WAP,2:WWW,3手持,4:客户端,5:客服,6:其他,7:短信,8:MM,9:实体卡,11:iPad,12:互动门户,13:SIG

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

integral

Response

String

0...1

当前积分

17.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.1.6 报文样例

请求方法

 
POST /portalapi/deductIntegral

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <integral>1200</integral>
    <reason></reason>
    <portalType>12</portalType>
    <channelCode>0001</channelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
<Response>
    <integral>150</integral>
</Response>
 

17.1.7 接口响应码

响应码

描述

200

成功

40022

积分字段为空

40023

积分字段格式不正确

4000

手机号为空

4001

手机号码非法

4002

手机号长度错误,非11

4444

用户积分不够

4443

更新用户积分失败

17.2 exchangeTicket 积分兑换接口

17.2.1 接口描述

互动wap调用此接口进行积分兑换操作

17.2.2 最后修改信息

17.2.3 调用方

17.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号码

sum

Request

String

1

兑换书券额度

portalType

Request

String

1

门户类型:1:WAP,2:WWW,3手持,4:客户端,5:客服,6:其他,7:短信,8:MM,9:实体卡,11:iPad,12:互动门户,13:SIG

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

17.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.2.6 报文样例

请求方法

 
POST /portalapi/exchangeTicket

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <sum>12</sum>
    <portalType>12</portalType>
    <channelCode>0001</channelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

17.2.7 接口响应码

响应码

描述

200

成功

4000

手机号为空

4001

手机号码非法

4002

手机号长度错误,非11

4205

兑换额度不是整数

2000

其他错误

4444

用户积分不够

17.3 getConsumeScore 获取用户积分

17.3.1 接口描述

门户需要在个人空间展示用户积分信息,以便用户兑换积分

17.3.2 最后修改信息

17.3.3 调用方

17.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

consumerScoreInfo

Response

ConsumerScoreInfo

1

消费积分信息

consumerScore

consumerScoreInfo

String

消费积分

yearlyScoreList

consumerScoreInfo

List

1

年积分列表

yearlyScoreInfo

yearlyScoreList

YearlyScoreInfo

1

年积分详细信息

yearlyScore

yearlyScoreInfo

String

0..1

年积分

monthlyScoreList

yearlyScoreInfo

List

1

月积分列表

monthlyScoreInfo

monthlyScoreList

MonthlyScoreInfo

1

单个月积分信息

monthlyScore

monthlyScoreInfo

String

1

月积分值

17.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.3.6 报文样例

请求方法

 
POST /portalapi/getConsumeScore

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <consumerScoreInfo>
        <consumerScore>0.0</consumerScore>
        <yearlyScoreList>
            <yearlyScoreInfo>
                <yearlyScore>2012,0,2013,12,31</yearlyScore>
                <monthlyScoreList>
                    <monthlyScoreInfo>
                        <monthlyScore>8,0</monthlyScore>
                    </monthlyScoreInfo>
                </monthlyScoreList>
            </yearlyScoreInfo>
        </yearlyScoreList>
    </consumerScoreInfo>
</Response>
 

17.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

17.4 getIntegralChangeList 查询积分兑换列表

17.4.1 接口描述

查询积分兑换列表

17.4.2 最后修改信息

17.4.3 调用方

17.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

integralItemIdList

Request

String

1

对换项ID(多个ID以逗号分割)

start

Request

String

1

起始记录数

count

Request

String

1

需要获取的记录数

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

记录总条数

integralChangeInfoList

Response

List

1

积分兑换列表

IntegralChangeInfo

integralChangeInfoList

IntegralChangeInfo

0..N

积分兑换信息

integralItemId

IntegralChangeInfo

String

1

对换项ID

integralItem

IntegralChangeInfo

String

0..1

兑换项名称

bookCardId

IntegralChangeInfo

String

0..1

书券ID

point

IntegralChangeInfo

String

1

积分

remark

IntegralChangeInfo

String

0..1

备注

17.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.4.6 报文样例

请求方法

 
POST /portalapi/getIntegralChangeList

请求报文

 
<Request>
    <integralItemIdList></integralItemIdList>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <integralChangeInfoList>
        <IntegralChangeInfo>
            <integralItemId>1</integralItemId>
            <integralItem>书券</integralItem>
            <bookCardId>1</bookCardId>
            <point>1</point>
            <remark>兑换1元书券需要100您要兑换</remark>
        </IntegralChangeInfo>
    </integralChangeInfoList>
</Response>
 

17.4.7 接口响应码

响应码

描述

200

成功

2000

其他异常

4200

ID为空

4201

ID不是整数

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

17.5 getPrerogativeInfos 根据用户手机号获取该用户所具有的特权信息

17.5.1 接口描述

根据用户手机号获取该用户所具有的特权信息

17.5.2 最后修改信息

17.5.3 调用方

17.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号

prerogativeCode

Request

String

0...1

被关注的手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

prerogativeList

Response

List

1

特权列表

PrerogativeInfo

prerogativeList

PrerogativeInfo

0...N

特权信息

prerogativeId

PrerogativeInfo

String

特权标识

prerogativeCode

PrerogativeInfo

String

特权编号

prerogativeName

PrerogativeInfo

String

特权名称

prerogativeDateType

PrerogativeInfo

String

特权时间类型

prerogativeGradeValue

PrerogativeInfo

String

特权级别

gradeId

PrerogativeInfo

String

级别标识

gradeName

PrerogativeInfo

String

级别名称

mobile

PrerogativeInfo

String

手机号码

17.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.5.6 报文样例

请求方法

 
POST /portalapi/getPrerogativeInfos

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <prerogativeCode>15077870014</prerogativeCode>
</Request>
 

响应报文

  
<Response>
    <prerogativeList>
        <PrerogativeInfo>
            <prerogativeId>1</prerogativeId>
            <prerogativeCode>1</prerogativeCode>
            <prerogativeName>鲜花</prerogativeName>
            <prerogativeDateType>3</prerogativeDateType>
            <prerogativeGradeValue>10</prerogativeGradeValue>
            <gradeId>1</gradeId>
            <gradeName>1</gradeName>
            <mobile>13770712841</mobile>
        </PrerogativeInfo>
    </prerogativeList>
</Response>
 

17.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

17.6 getProfessionConsumeScore 获取用户职业积分

17.6.1 接口描述

门户需要在个人空间展示用户职业积分信息

17.6.2 最后修改信息

17.6.3 调用方

17.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

professionScoreInfo

Response

ProfessionScoreInfo

1

职业积分信息

prosessionScore

professionScoreInfo

String

用户职业积分

yearlyScoreList

professionScoreInfo

List

1

年积分列表

yearlyProfessionScoreInfo

yearlyScoreList

YearlyProfessionScoreInfo

1

年积分详细信息

yearlyScore

yearlyProfessionScoreInfo

String

0..1

年积分

dataCutoverScore

yearlyProfessionScoreInfo

String

0..1

割接积分

monthlyScoreList

yearlyProfessionScoreInfo

List

1

月积分列表

monthlyScoreInfo

monthlyScoreList

MonthlyScoreInfo

1

单个月积分信息

monthlyScore

monthlyScoreInfo

String

1

月积分值

17.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.6.6 报文样例

请求方法

 
POST /portalapi/getProfessionConsumeScore

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <professionScoreInfo>
        <prosessionScore>0.0</prosessionScore>
        <yearlyScoreList>
            <yearlyProfessionScoreInfo>
                <yearlyScore>2012,0,2013,12,31</yearlyScore>
                <dataCutoverScore>5, 12618.8</dataCutoverScore>
                <monthlyScoreList>
                    <monthlyScoreInfo>
                        <monthlyScore>8,0</monthlyScore>
                    </monthlyScoreInfo>
                </monthlyScoreList>
            </yearlyProfessionScoreInfo>
        </yearlyScoreList>
    </professionScoreInfo>
</Response>
 

17.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

17.7 getUserGrade 查询用户级别

17.7.1 接口描述

门户需要在个人空间展示用户信息,需要查询用户级别

17.7.2 最后修改信息

17.7.3 调用方

17.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Response

String

1

用户标识

gradeId

Response

String

1

用户级别id

gradeName

Response

String

1

级别名称

nowExp

Response

String

1

当前经验值

nextExp

Response

String

1

距离下一级别的经验值

gradeTitle

Response

String

1

等级头衔

17.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.7.6 报文样例

请求方法

 
POST /portalapi/getUserGrade

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <msisdn>15077870000</msisdn>
    <gradeId>1</gradeId>
    <gradeName>1</gradeName>
    <nowExp>0.0</nowExp>
    <nextExp>100.1</nextExp>
    <gradeTitle>秀才</gradeTitle>
</Response>
 

17.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4230

无级别信息

17.8 getUserIntegExperGradeInfo 查询用户积分经验值等级

17.8.1 接口描述

门户需要在个人空间展示用户信息,需要查询用户积分经验值等级

17.8.2 最后修改信息

17.8.3 调用方

17.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Response

String

手机号码

integral

Response

String

积分

experience

Response

String

经验值

gradeId

Response

String

级别

gradeName

Response

String

级别名称

17.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.8.6 报文样例

请求方法

 
POST /portalapi/getUserIntegExperGradeInfo

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <msisdn>13770712841</msisdn>
    <integral>0.0</integral>
    <experience>0.0</experience>
    <gradeId>1</gradeId>
    <gradeName>1</gradeName>
</Response>
 

17.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4230

无等级级别记录

17.9 getUserMonthTicket 根据用户号码和身份查询免费月票

17.9.1 接口描述

门户需要在个人空间展示用户信息,需要查询用户月票数

17.9.2 最后修改信息

17.9.3 调用方

17.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

vip

Request

String

1

是否是vip

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalcount

Response

String

1

月票数量

17.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.9.6 报文样例

请求方法

 
POST /portalapi/getUserMonthTicket

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <vip>1</vip>
</Request>
 

响应报文

  
<Response>
    <totalcount>20</totalcount>
</Response>
 

17.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

40021

是否vip为空

17.10 qryScore 查询用户积分经验值

17.10.1 接口描述

门户需要在个人空间展示用户信息,需要查询用户经验值

17.10.2 最后修改信息

17.10.3 调用方

17.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

userId

Response

String

用户标识

memberLevel

Response

String

用户等级

memberTitleName

Response

String

等级名称

memberTitleValue

Response

String

等级的用户值

memberScore

Response

String

会员总累计积分

memberTitle

Response

String

会员级别

17.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.10.6 报文样例

请求方法

 
POST /portalapi/qryScore

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <userId>13770712841</userId>
    <memberLevel>1</memberLevel>
    <memberTitleName>1</memberTitleName>
    <memberTitleValue>100.0</memberTitleValue>
    <memberScore>0.0</memberScore>
    <memberTitle>第一级</memberTitle>
</Response>
 

17.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4230

无等级规则记录

17.11 qryScoreLevelRule 经验值等级规则查询

17.11.1 接口描述

门户需要在个人空间展示用户级别,需要查询级别生成规则

17.11.2 最后修改信息

17.11.3 调用方

17.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

levelRuleLst

Response

List

级别列表

LevelRule

levelRuleLst

LevelRule

级别信息

levelId

LevelRule

String

级别id

levelScore

LevelRule

String

级别对应经验值

levelName

LevelRule

String

级别标识

levelTitle

LevelRule

String

级别标题

17.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.11.6 报文样例

请求方法

 
POST /portalapi/qryScoreLevelRule

请求报文

 
<Request></Request>
 

响应报文

  
<Response>
    <levelRuleLst>
        <LevelRule>
            <levelId>1</levelId>
            <levelScore>100</levelScore>
            <levelName>1</levelName>
            <levelTitle>第一级</levelTitle>
        </LevelRule>
    </levelRuleLst>
</Response>
 

17.11.7 接口响应码

响应码

描述

200

成功

4230

无等级规则记录

17.12 updateIntegralByMobile 兑换书券扣除积分接口

17.12.1 接口描述

互动wap调用此接口进行兑换书券扣除积分操作

17.12.2 最后修改信息

17.12.3 调用方

17.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisn

Request

String

1

手机号码

point

Request

String

1

积分数

ticketSum

Request

String

1

兑换书券额度

ticketId

Request

String

1

书券编号

portalType

Request

String

1

门户类型:1:WAP,2:WWW,3手持,4:客户端,5:客服,6:其他,7:短信,8:MM,9:实体卡,11:iPad,12:互动门户,13:SIG

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

17.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

17.12.6 报文样例

请求方法

 
POST /portalapi/updateIntegralByMobile

请求报文

 
<Request>
    <msisn>15077870000</msisn>
    <point>1200</point>
    <ticketSum>200</ticketSum>
    <ticketId>1254</ticketId>
    <portalType>12</portalType>
    <channelCode>0001</channelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

17.12.7 接口响应码

响应码

描述

200

成功

4202

积分兑换数值为空

4203

积分兑换数值应为double

4000

手机号为空

4001

手机号码非法

4002

手机号长度错误,非11

4204

兑换额度为空

4205

兑换额度不是整数

4443

更新用户积分失败

4200

ID为空

4201

ID不是整数

18 空间

18.1 addBlackUser 添加黑名单接口

18.1.1 接口描述

添加黑名单(包含解除粉丝、关注、删除动态),在黑名单维护标签中使用

18.1.2 最后修改信息

18.1.3 调用方

18.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

msisdnname

Request

String

0...1

用户昵称,垃圾字段

blackmsisdn

Request

String

1

黑名单用户手机号

blackname

Request

String

0...1

黑名单用户昵称

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.1.6 报文样例

请求方法

 
POST /portalapi/addBlackUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <msisdnname>小白</msisdnname>
    <blackmsisdn>15077870014</blackmsisdn>
    <blackname>小黑</blackname>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

18.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.2 addShareInfoList 批量添加分享信息接口

18.2.1 接口描述

批量添加分享信息,如果已分享过同一本图书则更新分享时间和原因,在分享理由标签中使用

18.2.2 最后修改信息

18.2.3 调用方

18.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

loginType

Request

String

1

登录类型,话单字段,1:cmwap51:cmnet

shareInfoList

Request

List

1

分享列表

ShareInfo

shareInfoList

ShareInfo

0...N

分享信息

mobile

ShareInfo

String

1

手机号

bookId

ShareInfo

String

1

图书Id

shareReason

ShareInfo

String

0...1

分享原因,第一个shareInfo的分享原因必填

currentCatalog

ShareInfo

String

0..1

当前目录

thirdCatalog

ShareInfo

String

0..1

三级目录

secondCatalog

ShareInfo

String

0..1

二级目录

firstCatalog

ShareInfo

String

0..1

一级目录

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

portalType

Request

String

0...1

门户类型

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.2.6 报文样例

请求方法

 
POST /portalapi/addShareInfoList

请求报文

 
<Request>
    <loginType>1</loginType>
    <shareInfoList>
        <ShareInfo>
            <mobile>15077870000</mobile>
            <bookId>346684419</bookId>
            <shareReason>太好看了</shareReason>
            <currentCatalog>323</currentCatalog>
            <thirdCatalog>320</thirdCatalog>
            <secondCatalog>133</secondCatalog>
            <firstCatalog>121</firstCatalog>
        </ShareInfo>
    </shareInfoList>
    <sourceType>1</sourceType>
    <channelCode>0000</channelCode>
    <portalType>12</portalType>
</Request>
 

响应报文

  
 

18.2.7 接口响应码

响应码

描述

200

成功

2000

程序异常

40041

用户在黑名单列表中

40042

未绑定第三方渠道,分享书单(channelCode0001,绑定第三方渠道;channelCode0000或者空,则未绑定第三方渠道)

18.3 addUserAttention 添加关注接口

18.3.1 接口描述

添加关注,在关注|取消关注标签和粉丝列表标签和搜索结果标签和站内信列表标签和系统消息详情标签中使用

18.3.2 最后修改信息

18.3.3 调用方

18.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

actor

Request

String

1

手机号

toAttend

Request

String

1

被关注的手机号

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

营销渠道,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.3.6 报文样例

请求方法

 
POST /portalapi/addUserAttention

请求报文

 
<Request>
    <actor>15077870000</actor>
    <toAttend>15077870014</toAttend>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

18.3.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4186

加关注或粉丝失败

4187

关注用户在黑名单

4188

关注已存在

4193

关注自已

18.4 cancelUserAttention 取消关注接口

18.4.1 接口描述

取消关注,在取消关注确认标签中使用

18.4.2 最后修改信息

18.4.3 调用方

18.4.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

actor

Request

String

1

手机号

toCancel

Request

String

1

被关注的手机号

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

营销渠道,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.4.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.4.6 报文样例

请求方法

 
POST /portalapi/cancelUserAttention

请求报文

 
<Request>
    <actor>15077870000</actor>
    <toCancel>15077870014</toCancel>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

18.4.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4189

取消关注或粉丝失败

4194

取消关注删除好友动态失败

18.5 delAllShare 删除全部分享信息接口

18.5.1 接口描述

删除全部分享信息,删除分享审核信息,出经验成长的行为话单和分享排行话单,在主平台wap->书架->取消全部分享标签中使用

18.5.2 最后修改信息

18.5.3 调用方

18.5.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

loginType

Request

String

1

登录类型,话单字段,1:cmwap51:cmnet

mobile

Request

String

1

手机号

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

portalType

Request

String

0...1

门户类型

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.5.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.5.6 报文样例

请求方法

 
POST /portalapi/delAllShare

请求报文

 
<Request>
    <loginType>1</loginType>
    <mobile>15077870000</mobile>
    <sourceType>1</sourceType>
    <channelCode>0000</channelCode>
    <portalType>12</portalType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

18.5.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.6 delShareInfoList 批量删除分享表信息接口

18.6.1 接口描述

根据手机号码获取分享信息列表,在分享列表标签标签和分享列表/分享排行展示标签中使用

18.6.2 最后修改信息

18.6.3 调用方

18.6.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

loginType

Request

String

1

登录类型,话单字段,1:cmwap51:cmnet

shareInfoList

Request

List

1

分享列表

ShareInfo

shareInfoList

ShareInfo

1

分享信息

mobile

ShareInfo

String

1

手机号

bookId

ShareInfo

String

1

图书Id

currentCatalog

ShareInfo

String

0...1

当前目录

thirdCatalog

ShareInfo

String

0...1

三级目录

secondCatalog

ShareInfo

String

0...1

二级目录

firstCatalog

ShareInfo

String

0...1

一级目录

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

channelCode

Request

String

0...1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

portalType

Request

String

0...1

门户类型

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.6.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.6.6 报文样例

请求方法

 
POST /portalapi/delShareInfoList

请求报文

 
<Request>
    <loginType>1</loginType>
    <shareInfoList>
        <ShareInfo>
            <mobile>15077870000</mobile>
            <bookId>346684419</bookId>
            <currentCatalog>323</currentCatalog>
            <thirdCatalog>320</thirdCatalog>
            <secondCatalog>133</secondCatalog>
            <firstCatalog>121</firstCatalog>
        </ShareInfo>
    </shareInfoList>
    <sourceType>1</sourceType>
    <channelCode>0000</channelCode>
    <portalType>12</portalType>
</Request>
 

响应报文

  
 

18.6.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4506

分享信息不存在

18.7 generateMedal 下发勋章接口

18.7.1 接口描述

起线程异步执行下发勋章,snswap用户登陆时起线程调用

18.7.2 最后修改信息

18.7.3 调用方

18.7.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.7.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.7.6 报文样例

请求方法

 
POST /portalapi/generateMedal

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
 

18.7.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.8 getAttendsOrFansPageList 获取关注/粉丝分页列表接口

18.8.1 接口描述

获取关注/粉丝分页列表,在关注列表标签和粉丝列表标签和他人空间关注列表标签和他人空间粉丝列表标签中使用

18.8.2 最后修改信息

18.8.3 调用方

18.8.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

actor

Request

String

1

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

queryType

Request

String

1

查询类型,1:关注列表,2:粉丝列表

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

attendUserList

Response

List

1

关注或粉丝列表

AttendUserInfo

attendUserList

AttendUserInfo

1

关注或粉丝信息

userMobile

AttendUserInfo

String

1

手机号

createTime

AttendUserInfo

String

1

关系建立时间

isInterAttend

AttendUserInfo

String

1

是否为相互关注

isAttendUser

AttendUserInfo

String

1

关注列表:true,粉丝列表:false

recordid

AttendUserInfo

String

1

用户最新动态

recordid_type

AttendUserInfo

String

1

用户最新动态类型

recordidtime

AttendUserInfo

String

1

用户最新动态时间

nickNameComment

AttendUserInfo

String

1

昵称备注

18.8.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.8.6 报文样例

请求方法

 
POST /portalapi/getAttendsOrFansPageList

请求报文

 
<Request>
    <actor>15077870000</actor>
    <start>0</start>
    <count>0</count>
    <queryType>1</queryType>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <attendUserList>
        <AttendUserInfo>
            <userMobile>15077870004</userMobile>
            <createTime>2012-05-16</createTime>
            <isInterAttend>true</isInterAttend>
            <isAttendUser>true</isAttendUser>
            <recordid>15077870004</recordid>
            <recordid_type>2012-05-16</recordid_type>
            <recordidtime>true</recordidtime>
            <nickNameComment>true</nickNameComment>
        </AttendUserInfo>
    </attendUserList>
</Response>
 

18.8.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4180

查询类型为错误

18.9 getAuthorList 获取偶像信息列表接口

18.9.1 接口描述

获取偶像信息列表,在偶像列表标签和snswap缓存中调用

18.9.2 最后修改信息

18.9.3 调用方

18.9.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

typeInfoList

Response

List

1

偶像分类信息列表

typeInfo

typeInfoList

typeInfo

0...N

分类信息

classId

typeInfo

String

1

分类Id

className

typeInfo

String

1

分类名称

userLoveList

typeInfo

List

1

偶像列表

authorInfo

userLoveList

authorInfo

1...N

偶像信息

authorId

authorInfo

String

1

偶像Id

authorName

authorInfo

String

1

偶像名称

18.9.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.9.6 报文样例

请求方法

 
POST /portalapi/getAuthorList

请求报文

 
 

响应报文

  
<Response>
    <typeInfoList>
        <typeInfo>
            <classId>1</classId>
            <className>原创</className>
            <userLoveList>
                <authorInfo>
                    <authorId>29288802</authorId>
                    <authorName>唐家三少</authorName>
                </authorInfo>
                <authorInfo>
                    <authorId>1000224561</authorId>
                    <authorName>慕容雪村</authorName>
                </authorInfo>
            </userLoveList>
        </typeInfo>
        <typeInfo>
            <classId>2</classId>
            <className>女频</className>
            <userLoveList>
                <authorInfo>
                    <authorId>86372751</authorId>
                    <authorName>郭敬明</authorName>
                </authorInfo>
                <authorInfo>
                    <authorId>93922250</authorId>
                    <authorName>村上春树</authorName>
                </authorInfo>
            </userLoveList>
        </typeInfo>
    </typeInfoList>
</Response>
 

18.9.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.10 getBatchShareInfo 通过id列表批量获取分享信息接口

18.10.1 接口描述

通过id列表批量获取分享信息,在最新动态列表标签和分享理由显示标签中使用

18.10.2 最后修改信息

18.10.3 调用方

18.10.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

shareIdLst

Request

List

0...1

分享Id列表

string

shareIdLst

String

0...N

分享Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

shareInfoList

Response

List

1

分享列表

ShareInfo

shareInfoList

ShareInfo

0...N

分享信息

shareId

ShareInfo

String

1

分享Id

mobile

ShareInfo

String

1

手机号

bookId

ShareInfo

String

1

图书Id

shareReason

ShareInfo

String

1

分享原因

shareTime

ShareInfo

String

1

分享时间

18.10.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.10.6 报文样例

请求方法

 
POST /portalapi/getBatchShareInfo

请求报文

 
<Request>
    <shareIdLst>
        <string>2486664</string>
        <string>2486665</string>
    </shareIdLst>
</Request>
 

响应报文

  
<Response>
    <shareInfoList>
        <ShareInfo>
            <shareId>2486664</shareId>
            <mobile>15077870000</mobile>
            <bookId>346684419</bookId>
            <shareReason>就喜欢这本书</shareReason>
            <shareTime>20120517173344</shareTime>
        </ShareInfo>
        <ShareInfo>
            <shareId>2486665</shareId>
            <mobile>15077870000</mobile>
            <bookId>356121788</bookId>
            <shareReason>又喜欢这本书</shareReason>
            <shareTime>20120517173606</shareTime>
        </ShareInfo>
    </shareInfoList>
</Response>
 

18.10.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.11 getBlackUserList 获取黑名单用户列表接口

18.11.1 接口描述

获取黑名单用户列表,在黑名单列表标签中使用

18.11.2 最后修改信息

18.11.3 调用方

18.11.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

总记录数

blackUserList

Response

List

1

黑名单列表

UserBlackInfo

blackUserList

UserBlackInfo

0...N

黑名单信息

blackId

UserBlackInfo

String

1

黑名单Id

msisdn

UserBlackInfo

String

1

用户手机号

blackmsisdn

UserBlackInfo

String

1

黑名单用户手机号

blackname

UserBlackInfo

String

0...1

黑名单用户昵称

updatetime

UserBlackInfo

String

1

黑名单添加时间

18.11.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.11.6 报文样例

请求方法

 
POST /portalapi/getBlackUserList

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>2</totalCount>
    <blackUserList>
        <UserBlackInfo>
            <blackId>565</blackId>
            <msisdn>15077870000</msisdn>
            <blackmsisdn>15077870015</blackmsisdn>
            <blackname>小灰灰</blackname>
            <updatetime>2012-05-17 07:56:34</updatetime>
        </UserBlackInfo>
        <UserBlackInfo>
            <blackId>564</blackId>
            <msisdn>15077870000</msisdn>
            <blackmsisdn>15077870014</blackmsisdn>
            <blackname>小黑</blackname>
            <updatetime>2012-05-17 07:56:05</updatetime>
        </UserBlackInfo>
    </blackUserList>
</Response>
 

18.11.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

18.12 getBlogInfoListBySubjectId 悦·分享 获取与主题相关的微博信息列表接口

18.12.1 接口描述

悦·分享 根据主题ID获取相关微博信息(发布时间一个月以内、发布状态)列表,在主题日志标签和snswap缓存中使用

18.12.2 最后修改信息

18.12.3 调用方

18.12.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

subjectId

Request

String

1

主题Id

start

Request

String

1

分页编号

count

Request

String

1

分页长度

row__num

Request

String

1

最大显示数量

响应消息体

字段名

父字段名

字段类型

出现次数

描述

blogList

Response

List

1

主题相关微博列表

MBlogInfo

blogList

MBlogInfo

0...N

微博信息

mblog__id

MBlogInfo

String

1

微博Id

create__form

MBlogInfo

String

1

发表类型 0:原创日志,1:转发日志,2:转发并评论日志

ref__mblog__id

MBlogInfo

String

1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

mblog__text

MBlogInfo

String

1

微博内容

ref__book__id

MBlogInfo

String

1

提到书Id

ref__subject__id

MBlogInfo

String

1

提到主题Id

ref__subject__keywords

MBlogInfo

String

1

提到主题关键字

mobile

MBlogInfo

String

1

手机号(虚拟号)

create__time

MBlogInfo

String

1

发表时间

issue__status

MBlogInfo

String

1

发布状态 0:已发布,1:未发布,2:屏蔽,3:删除

forward__times

MBlogInfo

String

1

转发次数

comment__times

MBlogInfo

String

1

评论次数

room__id

MBlogInfo

String

1

直播间ID

url

MBlogInfo

String

0...1

url

totalCount

Response

String

1

总数量

subjectId

Response

String

1

主题Id

18.12.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.12.6 报文样例

请求方法

 
POST /portalapi/getBlogInfoListBySubjectId

请求报文

 
<Request>
    <subjectId>1</subjectId>
    <start>0</start>
    <count>0</count>
    <row__num>2</row__num>
</Request>
 

响应报文

  
<Response>
    <blogList>
        <MBlogInfo>
            <mblog__id>3000665</mblog__id>
            <create__form>0</create__form>
            <ref__mblog__id>0</ref__mblog__id>
            <mblog__text>#悦读中国#</mblog__text>
            <ref__book__id>0</ref__book__id>
            <ref__subject__id>1</ref__subject__id>
            <ref__subject__keywords>悦读中国</ref__subject__keywords>
            <mobile>18758257426</mobile>
            <create__time>20120515171438</create__time>
            <issue__status>0</issue__status>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id>0</room__id>
            <url></url>
        </MBlogInfo>
        <MBlogInfo>
            <mblog__id>3000589</mblog__id>
            <create__form>0</create__form>
            <ref__mblog__id>0</ref__mblog__id>
            <mblog__text>#悦读中国#22222222222222</mblog__text>
            <ref__book__id>0</ref__book__id>
            <ref__subject__id>1</ref__subject__id>
            <ref__subject__keywords>悦读中国</ref__subject__keywords>
            <mobile>13588161234</mobile>
            <create__time>20120510125209</create__time>
            <issue__status>0</issue__status>
            <forward__times>0</forward__times>
            <comment__times>0</comment__times>
            <room__id>0</room__id>
        </MBlogInfo>
    </blogList>
    <totalCount>2</totalCount>
    <subjectId>1</subjectId>
</Response>
 

18.12.7 接口响应码

响应码

描述

200

成功

2000

程序异常

60001

悦·分享 主题ID为空

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

20004

显示数量类型错误

18.13 getCatalogInfoList 根据主题Id获取图书专区列表接口

18.13.1 接口描述

根据主题Id获取图书专区列表,在主题小说展示列表标签和主题小说展示更多列表标签和主题分享图书排行标签和snswap缓存中使用

18.13.2 最后修改信息

18.13.3 调用方

18.13.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

subjectId

Request

String

1

主题Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

catalogInfoList

Response

List

1

图书专区列表

CatalogInfo

catalogInfoList

CatalogInfo

0...N

图书专区信息

blockId

CatalogInfo

String

1

图书Id

catalogId

CatalogInfo

String

1

图书专区Id

catalogName

CatalogInfo

String

1

专区名称

catalogDescrition

CatalogInfo

String

0...1

备注

catalogSort

CatalogInfo

String

1

排序序号

subjectId

Response

String

1

主题Id

18.13.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.13.6 报文样例

请求方法

 
POST /portalapi/getCatalogInfoList

请求报文

 
<Request>
    <subjectId>1</subjectId>
</Request>
 

响应报文

  
<Response>
    <catalogInfoList>
        <CatalogInfo>
            <blockId>81</blockId>
            <catalogId>137234401</catalogId>
            <catalogName>金庸</catalogName>
            <catalogDescrition>此数据跟主平台同步1</catalogDescrition>
            <catalogSort>1</catalogSort>
        </CatalogInfo>
        <CatalogInfo>
            <blockId>82</blockId>
            <catalogId>137192348</catalogId>
            <catalogName>古龙</catalogName>
            <catalogDescrition>此数据跟主平台同步2</catalogDescrition>
            <catalogSort>2</catalogSort>
        </CatalogInfo>
    </catalogInfoList>
    <subjectId>1</subjectId>
</Response>
 

18.13.7 接口响应码

响应码

描述

200

成功

2000

程序异常

60001

悦·分享 主题ID为空

18.14 getClassList 获取偏好信息列表接口

18.14.1 接口描述

获取全部偏好信息列表,在偏好列表标签和snswap缓存中调用

18.14.2 最后修改信息

18.14.3 调用方

18.14.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

typeInfoList

Response

List

1

偏好分类信息列表

typeInfo

typeInfoList

typeInfo

0...N

分类信息

classId

typeInfo

String

1

分类Id

className

typeInfo

String

1

分类名称

readLikeList

typeInfo

List

1

偏好列表

classInfo

readLikeList

classInfo

1...N

偏好信息

bookClassId

classInfo

String

1

偏好Id

bookClassName

classInfo

String

1

偏好名称

nodeId

classInfo

String

1

分类专区Id

18.14.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.14.6 报文样例

请求方法

 
POST /portalapi/getClassList

请求报文

 
 

响应报文

  
<Response>
    <typeInfoList>
        <typeInfo>
            <classId>1</classId>
            <className>图书</className>
            <readLikeList>
                <classInfo>
                    <bookClassId>112</bookClassId>
                    <bookClassName>理财</bookClassName>
                    <nodeId>6897851</nodeId>
                </classInfo>
                <classInfo>
                    <bookClassId>17</bookClassId>
                    <bookClassName>励志</bookClassName>
                    <nodeId>6897851</nodeId>
                </classInfo>
            </readLikeList>
        </typeInfo>
        <typeInfo>
            <classId>2</classId>
            <className>杂志</className>
            <readLikeList>
                <classInfo>
                    <bookClassId>157</bookClassId>
                    <bookClassName>军事</bookClassName>
                    <nodeId>29197759</nodeId>
                </classInfo>
                <classInfo>
                    <bookClassId>161</bookClassId>
                    <bookClassName>数码</bookClassName>
                    <nodeId>29198145</nodeId>
                </classInfo>
            </readLikeList>
        </typeInfo>
    </typeInfoList>
</Response>
 

18.14.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.15 getIllegalWordList 查询敏感词列表接口

18.15.1 接口描述

查询敏感词列表,snswap缓存中使用

18.15.2 最后修改信息

18.15.3 调用方

18.15.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

响应消息体

字段名

父字段名

字段类型

出现次数

描述

illegalList

Response

List

0...1

敏感词列表

string

illegalList

String

1...N

敏感词

18.15.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.15.6 报文样例

请求方法

 
POST /portalapi/getIllegalWordList

请求报文

 
 

响应报文

  
<Response>
    <illegalList>
        <string>做爱</string>
        <string>管理员</string>
        <string>2B青年</string>
    </illegalList>
</Response>
 

18.15.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.16 getMedalInfo 获取勋章信息接口

18.16.1 接口描述

根据勋章Id查询该勋章信息,在个人勋章列表标签中调用

18.16.2 最后修改信息

18.16.3 调用方

18.16.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

medalId

Request

String

1

勋章Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

medalInfo

Response

medalInfo

0...1

勋章信息

medalId

medalInfo

String

1

勋章Id

medalName

medalInfo

String

1

勋章名

medalImg

medalInfo

String

1

勋章图片地址

medalGetCondition

medalInfo

String

1

获取勋章条件:1:粉丝数,2:站外转发数,3:站外分享数

medalGetValue

medalInfo

String

1

获取勋章条件值

medalReward

medalInfo

String

1

勋章奖励内容:1.积分

medalRewardValue

medalInfo

String

1

勋章奖励值

medalFatherId

medalInfo

String

1

勋章父级:1.互动勋章

medalUrl

medalInfo

String

1

勋章URL

medaDesc

medalInfo

String

0...1

勋章描述

18.16.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.16.6 报文样例

请求方法

 
POST /portalapi/getMedalList

请求报文

 
<Request>
    <medalId>50</medalId>
</Request>
 

响应报文

  
<Response>
    <medalInfo>
        <medalId>50</medalId>
        <medalName>皇冠</medalName>
        <medalImg>/medal/201205/{imagePath}/1336971180772.jpg</medalImg>
        <medalGetCondition>1</medalGetCondition>
        <medalGetValue>99999999</medalGetValue>
        <medalReward>1</medalReward>
        <medalRewardValue>10000</medalRewardValue>
        <medalFatherId>1</medalFatherId>
        <medalUrl>http://wap.cmread.com/sns/wap/p/mblog/testindex.jsp</medalUrl>
        <medaDesc>算你狠</medaDesc>
    </medalInfo>
</Response>
 

18.16.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.17 getMsgFriendPageList 查询站内信好友分页列表接口

18.17.1 接口描述

查询可以发站内信的好友(互相关注)分页列表,在好友列表标签中调用

18.17.2 最后修改信息

18.17.3 调用方

18.17.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

start

Request

String

1

查询的起始位置

count

Request

String

1

查询的个数

order

Request

String

1

按关注时间排序,ascdesc

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

msgFriendInfo

Response

List

1

好友信息列表

MsgFriendInfo

msgFriendInfo

MsgFriendInfo

0...N

好友信息

msisdn

MsgFriendInfo

String

1

手机号

createTime

MsgFriendInfo

String

1

关注时间

nicknameComment

MsgFriendInfo

String

0...1

昵称备注

18.17.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.17.6 报文样例

请求方法

 
POST /portalapi/getMsgFriendPageList

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <start>1</start>
    <count>11</count>
    <order>asc</order>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>1</totalRecordCount>
    <msgFriendInfo>
        <MsgFriendInfo>
            <msisdn>15077870003</msisdn>
            <createTime>2012-05-16</createTime>
            <nicknameComment>hehe</nicknameComment>
        </MsgFriendInfo>
    </msgFriendInfo>
</Response>
 

18.17.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

40031

排序参数非法

18.18 getNewDynamicList 通过类型和所有者手机号获取他关注的那类最新动态接口

18.18.1 接口描述

通过类型和所有者手机号获取他关注的那类最新动态,在最新动态列表标签中使用

18.18.2 最后修改信息

18.18.3 调用方

18.18.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

owner

Request

String

1

手机号

attendedmobile

Request

String

0...1

关注手机号

type

Request

String

0...1

动态类型,0:全部(排除3567) 1:借阅2:赠送, 3:主题, 4:推荐 5: 主题评论 6.页面评论 7.书评,8:分享,9:言论,10:帖子,11:投月票

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

newDynamicInfoList

Response

List

1

最新动态信息列表

NewDynamicInfo

newDynamicInfoList

NewDynamicInfo

0...N

最新动态信息

owner

NewDynamicInfo

String

1

手机号

attendedMobile

NewDynamicInfo

String

1

关注手机号

recordId

NewDynamicInfo

String

1

记录id

type

NewDynamicInfo

String

1

动态类型,0:全部 1:借阅2:赠送, 3:主题, 4:推荐 5: 主题评论 6.页面评论 7.书评,8:分享,9:言论,10:帖子,11:投月票

createTime

NewDynamicInfo

String

1

动态的执行时间

18.18.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.18.6 报文样例

请求方法

 
POST /portalapi/getNewDynamicList

请求报文

 
<Request>
    <owner>13904127400</owner>
    <attendedmobile></attendedmobile>
    <type>8</type>
    <start>1</start>
    <count>2</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>50</totalRecordCount>
    <newDynamicInfoList>
        <NewDynamicInfo>
            <owner>13904127400</owner>
            <attendedMobile>13478098413</attendedMobile>
            <recordId>388907</recordId>
            <type>8</type>
            <createTime>20111217173634</createTime>
        </NewDynamicInfo>
        <NewDynamicInfo>
            <owner>13904127400</owner>
            <attendedMobile>13478098413</attendedMobile>
            <recordId>388906</recordId>
            <type>8</type>
            <createTime>20111217173634</createTime>
        </NewDynamicInfo>
    </newDynamicInfoList>
</Response>
 

18.18.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

4602

类型为空

4603

类型不是数字

18.19 getShareInfoList 根据手机号码获取分享信息列表接口

18.19.1 接口描述

根据手机号码获取分享信息列表,在分享列表标签标签和分享列表/分享排行展示标签中使用

18.19.2 最后修改信息

18.19.3 调用方

18.19.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号

start

Request

String

1

分页编号

count

Request

String

1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalRecordCount

Response

String

1

总记录数

shareInfoList

Response

List

1

分享列表

ShareInfo

shareInfoList

ShareInfo

1

分享信息

shareId

ShareInfo

String

1

分享Id

mobile

ShareInfo

String

1

手机号

bookId

ShareInfo

String

1

图书Id

shareReason

ShareInfo

String

1

分享原因

shareTime

ShareInfo

String

1

分享时间

18.19.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.19.6 报文样例

请求方法

 
POST /portalapi/getShareInfoList

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <start>0</start>
    <count>0</count>
</Request>
 

响应报文

  
<Response>
    <totalRecordCount>2</totalRecordCount>
    <shareInfoList>
        <ShareInfo>
            <shareId>2486663</shareId>
            <mobile>15077870000</mobile>
            <bookId>346684419</bookId>
            <shareReason>就喜欢这本书</shareReason>
            <shareTime>20120517111222</shareTime>
        </ShareInfo>
        <ShareInfo>
            <shareId>2486662</shareId>
            <mobile>15077870000</mobile>
            <bookId>356121788</bookId>
            <shareReason>这本书太好了</shareReason>
            <shareTime>20120516172510</shareTime>
        </ShareInfo>
    </shareInfoList>
</Response>
 

18.19.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

18.20 getShareToOutSiteCommentList 获取同步到外站言论接口

18.20.1 接口描述

获取同步到外站言论

18.20.2 最后修改信息

18.20.3 调用方

18.20.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

commentType

Request

String

1

言论类型,1:日志,2:评论,3:分享,4:帖子

start

Request

String

0...1

分页编号

count

Request

String

0...1

分页长度

响应消息体

字段名

父字段名

字段类型

出现次数

描述

totalCount

Response

String

1

手机号

outSiteCommentList

Response

List

1

分享到站外列表

OutSiteCommentInfo

outSiteCommentList

OutSiteCommentInfo

0...N

分享到站外言论的信息

commentId

OutSiteCommentInfo

String

1

言论Id

commentType

OutSiteCommentInfo

String

1

言论类型

commentContent

OutSiteCommentInfo

String

1

言论内容

issueStatus

OutSiteCommentInfo

String

1

发布状态 已发布:0 未发布:1 屏蔽:2 删除:3

auditStatus

OutSiteCommentInfo

String

1

审核状态 待审核:0 已审核:1

createForm

OutSiteCommentInfo

String

1

发表类型 原创日志:0 转发日志:1 转发并评论日志:2

refMblogId

OutSiteCommentInfo

String

1

转发日志id,对于原创日志,此字段为空;对于转发日志,此字段是最原始出处的原创日志id

subjectId

OutSiteCommentInfo

String

0

主题Id

refbookId

OutSiteCommentInfo

String

0

提到书Id

createTime

OutSiteCommentInfo

String

1

发表时间

forwardTimes

OutSiteCommentInfo

String

1

转发次数

commentTimes

OutSiteCommentInfo

String

1

评论次数

cmccCount

OutSiteCommentInfo

String

1

移动微博带来人数

sinaCount

OutSiteCommentInfo

String

1

新浪微博带来人数

qqCount

OutSiteCommentInfo

String

1

腾讯微博带来人数

renrenCount

OutSiteCommentInfo

String

1

人人带来人数

tianyaCount

OutSiteCommentInfo

String

1

天涯带来人数

fId

OutSiteCommentInfo

String

1

版块ID

fName

OutSiteCommentInfo

String

1

版块名称

pTitle

OutSiteCommentInfo

String

1

帖子标题

18.20.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.20.6 报文样例

请求方法

 
POST /portalapi/getShareToOutSiteCommentList

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <commentType>1</commentType>
    <start>1</start>
    <count>5</count>
</Request>
 

响应报文

  
<Response>
    <totalCount>1</totalCount>
    <outSiteCommentList>
        <OutSiteCommentInfo>
            <commentId>1</commentId>
            <commentType>1</commentType>
            <commentContent>表来烦我</commentContent>
            <issueStatus>表来烦我</issueStatus>
            <auditStatus>表来烦我</auditStatus>
            <createForm>1</createForm>
            <refMblogId>1</refMblogId>
            <subjectId>1</subjectId>
            <refbookId>1</refbookId>
            <createTime>201210101000000</createTime>
            <forwardTimes>0</forwardTimes>
            <commentTimes>0</commentTimes>
            <cmccCount>1</cmccCount>
            <sinaCount>1</sinaCount>
            <qqCount>1</qqCount>
            <renrenCount>1</renrenCount>
            <tianyaCount>1</tianyaCount>
            <fId>1</fId>
            <fName>1</fName>
            <pTitle>1</pTitle>
        </OutSiteCommentInfo>
    </outSiteCommentList>
</Response>
 

18.20.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

40040

言论类型非法

4003

分页编号为空

4004

分页编号为非数字

4005

分页长度为空

4006

分页长度为非数字

18.21 getSNSInfo 查询关注和粉丝数量接口

18.21.1 接口描述

根据手机号查询该用户关注和粉丝数量,在关注标签和粉丝标签和他的圈子展示标签和我的圈子展示标签和他人空间关注粉丝数量标签中使用

18.21.2 最后修改信息

18.21.3 调用方

18.21.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

atnum

Response

String

1

关注数

fansnum

Response

String

1

粉丝数

18.21.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.21.6 报文样例

请求方法

 
POST /portalapi/getSNSInfo

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <atnum>2</atnum>
    <fansnum>5</fansnum>
</Response>
 

18.21.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.22 getSubjectInfoBySubjectId 根据主题Id获取主题信息接口

18.22.1 接口描述

根据主题Id获取主题信息,在发日志标签和日志详情标签和日志广场标签和更多日志标签和个人空间日志列表标签和snswap缓存中使用

18.22.2 最后修改信息

18.22.3 调用方

18.22.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

subjectId

Request

String

1

主题Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

subjectBean

Response

subjectBean

1

主题信息

subjectId

subjectBean

String

1

主题Id

subjectName

subjectBean

String

1

主题名称

subjectUrl

subjectBean

String

1

主题url地址

subjectMemo

subjectBean

String

1

主题说明

createTime

subjectBean

String

1

创建日期

startTime

subjectBean

String

1

活动开始时间

endTime

subjectBean

String

1

活动结束时间

18.22.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.22.6 报文样例

请求方法

 
POST /portalapi/getSubjectInfoBySubjectId

请求报文

 
<Request>
    <subjectId>1</subjectId>
</Request>
 

响应报文

  
<Response>
    <subjectBean>
        <subjectId>1</subjectId>
        <subjectName>悦读中国</subjectName>
        <subjectUrl>http://10.166.112.68:8099/sns/wap/p/readstar.jsp</subjectUrl>
        <subjectMemo>默认显示的主题</subjectMemo>
        <createTime>2011-12-31 17:53:16.0</createTime>
        <startTime>2011-12-30 00:00:00.0</startTime>
        <endTime>9999-12-30 00:00:00.0</endTime>
    </subjectBean>
</Response>
 

18.22.7 接口响应码

响应码

描述

200

成功

2000

程序异常

60001

悦·分享 主题ID为空

18.23 getUserMedalIdList 获取用户勋章Id列表接口

18.23.1 接口描述

根据手机号查询该用户的个人勋章Id列表,在个人勋章列表标签中调用

18.23.2 最后修改信息

18.23.3 调用方

18.23.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

medalList

Response

List

1

勋章Id列表

string

medalList

String

1

勋章Id

18.23.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.23.6 报文样例

请求方法

 
POST /portalapi/getUserMedalIdList

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <medalList>
        <string>10</string>
        <string>11</string>
        <string>16</string>
    </medalList>
</Response>
 

18.23.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.24 getUserStatus 用户互动信息查询接口

18.24.1 接口描述

用户互动信息查询,在客服平台中调用

18.24.2 最后修改信息

18.24.3 调用方

18.24.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

integral

Response

String

1

积分余额

attend

Response

String

1

关注数

fans

Response

String

1

粉丝数

shareBook

Response

String

1

分享图书数

shareBookOut

Response

String

1

分享图书到站外数

shareSaying

Response

String

1

分享言论到站外数

18.24.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.24.6 报文样例

请求方法

 
POST /portalapi/getUserStatus

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
</Request>
 

响应报文

  
<Response>
    <integral>43.0</integral>
    <attend>2</attend>
    <fans>5</fans>
    <shareBook>2</shareBook>
    <shareBookOut>20</shareBookOut>
    <shareSaying>10</shareSaying>
</Response>
 

18.24.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.25 isBlackUser 判断用户是否是黑名单用户接口

18.25.1 接口描述

判断用户是否是黑名单用户,在黑名单维护标签中使用

18.25.2 最后修改信息

18.25.3 调用方

18.25.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

blackmsisdn

Request

String

1

判断是否在黑名单中的手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

blackFlag

Response

String

1

blackmsisdn是否在黑名单中

18.25.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.25.6 报文样例

请求方法

 
POST /portalapi/isBlackUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <blackmsisdn>15077870014</blackmsisdn>
</Request>
 

响应报文

  
<Response>
    <blackFlag>false</blackFlag>
</Response>
 

18.25.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.26 IsExitsAttend 判断是否已经关注用户接口

18.26.1 接口描述

判断是否已经关注用户,在关注|取消关注标签和帖子链接标签和动态链接标签中使用

18.26.2 最后修改信息

18.26.3 调用方

18.26.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

actor

Request

String

1

手机号

toCheck

Request

String

1

被关注的手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.26.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.26.6 报文样例

请求方法

 
POST /portalapi/IsExitsAttend

请求报文

 
<Request>
    <actor>15077870000</actor>
    <toCheck>15077870014</toCheck>
</Request>
 

响应报文

  
 

18.26.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4192

没有关注用户

18.27 isShared 判断图书是否被分享过接口

18.27.1 接口描述

判断图书是否被分享过,在分享理由标签中使用

18.27.2 最后修改信息

18.27.3 调用方

18.27.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号

bookid

Request

String

1

图书Id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

shareInfo

Response

shareInfo

0...1

分享信息

shareId

shareInfo

String

1

分享Id

mobile

shareInfo

String

1

手机号

bookId

shareInfo

String

1

图书Id

shareReason

shareInfo

String

1

分享原因

shareTime

shareInfo

String

1

分享时间

18.27.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.27.6 报文样例

请求方法

 
POST /portalapi/isShared

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <bookid>346684419</bookid>
</Request>
 

响应报文

  
<Response>
    <shareInfo>
        <shareId>2486664</shareId>
        <mobile>15077870000</mobile>
        <bookId>346684419</bookId>
        <shareReason>太好看了</shareReason>
        <shareTime>20120517231029</shareTime>
    </shareInfo>
</Response>
 

18.27.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4504

图书id为空

4505

图书未被分享过

18.28 removeBlackUser 解除黑名单接口

18.28.1 接口描述

解除黑名单,在黑名单操作结果页标签中使用

18.28.2 最后修改信息

18.28.3 调用方

18.28.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

blackmsisdn

Request

String

1

黑名单用户手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.28.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.28.6 报文样例

请求方法

 
POST /portalapi/removeBlackUser

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <blackmsisdn>15077870014</blackmsisdn>
</Request>
 

响应报文

  
 

18.28.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.29 searchAttendOrFanUser 查询关注/粉丝接口

18.29.1 接口描述

根据手机号查询关注/粉丝,在搜索结果标签中使用

18.29.2 最后修改信息

18.29.3 调用方

18.29.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

actor

Request

String

1

手机号

toSearch

Request

String

1

手机号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

searchResult

Response

searchResult

0...1

搜索结果

userMobile

searchResult

String

1

手机号

createTime

searchResult

String

1

关系建立时间

isInterAttend

searchResult

String

1

是否为相互关注

isAttendUser

searchResult

String

1

在关注列表中:true,在粉丝列表中:false

18.29.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.29.6 报文样例

请求方法

 
POST /portalapi/searchAttendOrFanUser

请求报文

 
<Request>
    <actor>15077870000</actor>
    <toSearch>15077870011</toSearch>
</Request>
 

响应报文

  
<Response>
    <searchResult>
        <userMobile>15077870011</userMobile>
        <createTime>2012-05-17</createTime>
        <isInterAttend>false</isInterAttend>
        <isAttendUser>false</isAttendUser>
    </searchResult>
</Response>
 

18.29.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

18.30 shareChangeNotify 分享审核通知接口

18.30.1 接口描述

分享审核通知,审核平台发布或屏蔽用户的分享记录时,调此接口通知出经验成长的行为话单和分享排行话单,在审核平台中调用

18.30.2 最后修改信息

18.30.3 调用方

18.30.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

changeType

Request

String

1

操作类型,1:屏蔽,2:发布

bookId

Request

String

1

图书Id

bookType

Request

String

0

垃圾字段

bookName

Request

String

0

垃圾字段

shareTime

Request

String

1

分享时间,格式yyyyMMddHHmmss

portalType

Request

String

0...1

门户类型

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

channelCode

Request

String

0..1

渠道代码:0000:自有平台直接接入,0001:移动梦网接入

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0...1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.30.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.30.6 报文样例

请求方法

 
POST /portalapi/shareChangeNotify

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <changeType>1</changeType>
    <bookId>123456</bookId>
    <bookType></bookType>
    <bookName></bookName>
    <shareTime>20120521204400</shareTime>
    <portalType>12</portalType>
    <sourceType>1</sourceType>
    <channelCode>0000</channelCode>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
 

18.30.7 接口响应码

响应码

描述

200

成功

2000

程序异常

18.31 updateNicknameComment 修改好友昵称备注接口

18.31.1 接口描述

修改好友(关注/粉丝)昵称备注,在圈子备注修改标签中使用

18.31.2 最后修改信息

18.31.3 调用方

18.31.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

operateMsisdn

Request

String

1

操作者手机号

updateMsisdn

Request

String

1

好友手机号

nicknameComment

Request

String

1

昵称备注

action

Request

String

1

操作类型,1:关注,2:粉丝

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.31.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.31.6 报文样例

请求方法

 
POST /portalapi/updateNicknameComment

请求报文

 
<Request>
    <operateMsisdn>15077870000</operateMsisdn>
    <updateMsisdn>15077870003</updateMsisdn>
    <nicknameComment>hehe</nicknameComment>
    <action>1</action>
</Request>
 

响应报文

  
 

18.31.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

40024

action字段非法

40025

nicknameComment字段过长

40026

关注关系不存在

40027

粉丝关系不存在

18.32 updateShareInfo 更新分享原因接口

18.32.1 接口描述

更新分享原因(分享时间更新到当前时间,分享审核表中也更新或插入记录),在分享理由标签中使用

18.32.2 最后修改信息

18.32.3 调用方

18.32.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

mobile

Request

String

1

手机号

bookid

Request

String

1

图书Id

shareReason

Request

String

1

分享原因

响应消息体

字段名

父字段名

字段类型

出现次数

描述

18.32.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.32.6 报文样例

请求方法

 
POST /portalapi/updateShareInfo

请求报文

 
<Request>
    <mobile>15077870000</mobile>
    <bookid>346684419</bookid>
    <shareReason>又看了一边,太好看了</shareReason>
</Request>
 

响应报文

  
 

18.32.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

4502

分享理由不能为空

4503

更新分享理由失败

4504

图书id为空

40041

用户在黑名单中

18.33 userCheckIn 用户报到接口

18.33.1 接口描述

用户报到可以增加积分(通过出报到积分话单实现),连续报到会得到更多积分,可以在snsmanager中配置通过连续报到增加的积分上限。在马上报到标签中使用

18.33.2 最后修改信息

18.33.3 调用方

18.33.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

手机号

clientIP

Request

String

1

浏览器IP

platform

Request

String

0...1

门户类型,话单字段

ChannelCode

Request

String

0...1

渠道参数,话单字段

sourceType

Request

String

0...1

运营频道类型: 1:书籍运营频道;2:漫画运营频道;3:杂志运营频道;4:互动运营频道;5:听书运营频道;6:手机报;7:新浪微博;8、新浪阅读频道;14:uues 书籍;15:行业企业书屋;16:行业移动学习

currentCatalog

Request

String

0...1

当前目录

thirdCatalog

Request

String

0...1

三级目录

secondCatalog

Request

String

0..1

二级目录

firstCatalog

Request

String

0...1

一级目录

响应消息体

字段名

父字段名

字段类型

出现次数

描述

userCheckinInfo

Response

userCheckinInfo

1

签到提示语信息

reportDays

userCheckinInfo

String

1

连续报到天数

integralNumTaday

userCheckinInfo

String

1

今天获得的积分数

integralNumTomorrom

userCheckinInfo

String

1

明天继续报到将获得的积分数

resultcode

userCheckinInfo

String

1

结果码

18.33.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

18.33.6 报文样例

请求方法

 
POST /portalapi/userCheckIn

请求报文

 
<Request>
    <msisdn>15077870000</msisdn>
    <clientIP>10.166.112.146</clientIP>
    <platform>12</platform>
    <ChannelCode>000001</ChannelCode>
    <sourceType>1</sourceType>
    <currentCatalog>323</currentCatalog>
    <thirdCatalog>320</thirdCatalog>
    <secondCatalog>133</secondCatalog>
    <firstCatalog>121</firstCatalog>
</Request>
 

响应报文

  
<Response>
    <userCheckinInfo>
        <reportDays>10</reportDays>
        <integralNumTaday>45</integralNumTaday>
        <integralNumTomorrom>45</integralNumTomorrom>
        <resultcode>200</resultcode>
    </userCheckinInfo>
</Response>
 

18.33.7 接口响应码

响应码

描述

200

成功

2000

程序异常

4000

手机号为空

4001

手机号非法

4002

手机号长度错误,非11

40035

IP不能为空

40036

IP格式错误

19 论坛

19.1 getLinkCircleUrl 查询轮循链接url列表接口

19.1.1 接口描述

查询轮循链接url列表。在链接轮循标签中使用

19.1.2 最后修改信息

19.1.3 调用方

19.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

pageLabelId

Request

String

1

页面标签id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

linkUrlList

Response

List

0...1

轮循链接列表

linkCircleUrl

linkUrlList

linkCircleUrl

1...N

轮循链接url

pageLabelId

linkCircleUrl

String

1

页面标签id

linkIndex

linkCircleUrl

String

1

序号

linkDesc

linkCircleUrl

String

1

链接描述

linkUrl

linkCircleUrl

String

1

链接url

19.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

19.1.6 报文样例

请求方法

 
POST /portalapi/getLinkCircleUrl

请求报文

 
<Request>
    <pageLabelId></pageLabelId>
</Request>
 

响应报文

  
<Response>
    <linkUrlList>
        <linkCircleUrl>
            <pageLabelId>31530</pageLabelId>
            <linkIndex>1</linkIndex>
            <linkDesc>hehe1</linkDesc>
            <linkUrl>/hehe1</linkUrl>
        </linkCircleUrl>
        <linkCircleUrl>
            <pageLabelId>31530</pageLabelId>
            <linkIndex>2</linkIndex>
            <linkDesc>hehe2</linkDesc>
            <linkUrl>/hehe2</linkUrl>
        </linkCircleUrl>
    </linkUrlList>
</Response>
 

19.1.7 接口响应码

响应码

描述

200

成功

2000

程序异常

40020

页面标签id为空

20 通知

20.1 userChange 用户变更

20.1.1 接口描述

主平台manager在黑名单列表变更时发送

20.1.2 最后修改信息

20.1.3 调用方

20.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

type

Request

String

1

变更类型:3、黑名单变更

userList

Request

List

1

号码列表

msisdn

userList

String

1..N

黑名单号码

响应消息体

字段名

父字段名

字段类型

出现次数

描述

20.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

涉及的缓存

缓存名

描述

缓存类型

20.1.6 报文样例

请求方法

 
POST /portalapi/userChange

请求报文

 
<Request>
    <type>3</type>
    <userList>
        <msisdn>15077870000</msisdn>
    </userList>
</Request>
 

响应报文

  
 

20.1.7 接口响应码

响应码

描述

200

成功

21 CMI19

21.1 signIn 签到

21.1.1 接口描述

用户签到

21.1.2 最后修改信息

21.1.3 调用方

21.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

响应消息体

字段名

父字段名

字段类型

出现次数

描述

havingPrize

Response

Int

1

奖励状态{0:未获得奖励,1:连续签到奖励,2:累计签到奖励,3:两种奖励都有

prizeList

Response

List

0...1

奖励集合

prize

prizeList

Prize

0...n

奖品

givingType

prize

int

1

获奖条件{1:连续签到,2:累计签到}

prizeType

prize

int

1

奖品类型{0:书券,1:道具,2:抽奖}

prizeName

prize

String

1

奖品名称

prizeCode

prize

String

1

奖品代码{书券ID,道具ID,抽奖活动ID……}

prizeNum

prize

int

1

奖品数量

description

prize

String

0..1

领奖描述

url

prize

String

0..1

抽象地址.when prizeType==2,非空,表示领奖地址

 

21.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

sns_sign_in_info

签到信息表

sns_sign_in_prize_records_**01~12

奖品记录表

 

涉及的缓存

缓存名

描述

缓存类型

21.1.6 报文样例

请求方法

 
POST /portalapi/signin

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

 
< Response >
<havingPrize>1</havingPrize>
<prizeList>
<prize>
<prizeType>1</prizeType>
<prizeName>连续奖励礼包道具</prizeName>
<prizeCode>445</prizeCode>
<prizeNum>3</prizeNum>
<description>连续签到1天,获得3个礼包道具奖励</description>
<givingType>1</givingType>
</prize>
</prizeList>
</ Response >
 

21.1.7 接口响应码

响应码

描述

2000

其他错误

601001

阅读号为空

601002

阅读号非法

601003

重复签到

21.2 getSignInInfo 查询用户签到信息

21.2.1 接口描述

查询用户签到信息

21.2.2 最后修改信息

21.2.3 调用方

21.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

身份id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

curDate

Response

String

1

当前日期(YYYYMMDD)

signInStatus

Response

Init

1

当天签到状态.{0:未签到,1:已签到}

continuousCount

Response

Init

1

连续签到天数

cumulativeCount

Response

Init

1

本月累计签到天数[0,31]

curMonthSignInRecords

Response

List

0..1

本月已签到日期记录

string

curMonthSignInRecords

String

0..n

日期(YYYYMMDD)

 

21.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

sns_sign_in_info

签到信息表

 

涉及的缓存

缓存名

描述

缓存类型

21.2.6 报文样例

请求方法

 
POST /portalapi/ getSignInInfo

请求报文

 
<Request>
    <msisdn>13712345678</msisdn>
</Request>
 

响应报文

 
<Request>
<curDate>20150828</curDate>
<signInStatus>0</signInStatus>
<continuousCount>0</continuousCount>
<cumulativeCount>1</cumulativeCount>
<curMonthSignInRecords>
    <string>20150813</string>
</curMonthSignInRecords>
</Request>
 

21.2.7 接口响应码

响应码

描述

2000

其他错误

601001

阅读号为空

601002

阅读号非法

21.3 getSignInPrizeRecords查询奖励明细接口

21.3.1 接口描述

查询奖励明细

21.3.2 最后修改信息

21.3.3 调用方

21.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

身份id

start

Request

Init

1

起始位置

count

Request

Init

1

条数

month

Request

String

1

查询月份YYYYMM

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

Init

1

查询月份获奖记录总数

prizeList

Response

List

0..1

奖励记录集合

prize

prizeList

prize

0..n

连续签到天数

givingType

prize

Init

1

获奖条件{1:连续签到,2:累计签到}

prizeType

prize

Init

1

奖品类型{0:书券;1:道具; 2:抽奖}

prizeName

prize

String

1

奖品名称

prizeNum

prize

Init

1

奖品数量

date

prize

tring

1

获奖时间(YYYYMMDD)

 

21.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

sns_sign_in_prize_records_**01~12

奖品记录表

 

涉及的缓存

缓存名

描述

缓存类型

21.3.6 报文样例

请求方法

 
POST /portalapi/ getSignInInfo

请求报文

 
<Request>
<msisdn>13871590176</msisdn>
<start>1</start>
<count>10</count>
<month>201508</month>
</Request>
 

响应报文

 
<Response>
<total>3</total>
<prizeList>
   <prize>
     <givingType>1</givingType>
     <prizeType>1</prizeType>
     <prizeName>连续奖励礼包道具</prizeName>
     <prizeNum>3</prizeNum>
     <date>20150813</date>
    </prize>
    <prize>
     <givingType>2</givingType>
     <prizeType>1</prizeType>
     <prizeName>累计奖励礼包道具</prizeName>
     <prizeNum>10</prizeNum>
     <date>20150813</date>
    </prize>
    <prize>
     <givingType>2</givingType>
     <prizeType>2</prizeType>
     <prizeName>累计奖励抽奖</prizeName>
     <prizeNum>10</prizeNum>
     <date>20150813</date>
    </prize>
 </prizeList>
</Response>
 

21.3.7 接口响应码

响应码

描述

601001

阅读号为空

601002

阅读号非法

601100

起始位置为空

601102

起始位置非数字

601103

条数为空

601104

条数非数字

601105

查询月份为空

601006

查询月份非法

2000

其他错误

22 CMI21

22.1 getrewardsinfo查询打赏明细

22.1.1 接口描述

查询打赏明细接口

22.1.2 最后修改信息

22.1.3 调用方

22.1.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

recordId

Request

String

1

动态记录id

响应消息体

字段名

父字段名

字段类型

出现次数

描述

Msisdn

Response

String

1

身份id

bookId

Response

String

1

图书id

rewardMount

Response

String

1

打赏金额

recordId

Response

String

1

打赏记录id, 对应getNewDynamicList接口返回的recordid

recordTime

Response

String

1

记录时间, 格式:YYYYMMDDHHMMSS

dateTime

Response

String

1

话单产生时间,格式:YYYYMMDDHHMMSS

 

22.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

SNS_REWARDS_INFO

打赏记录表

涉及的缓存

缓存名

描述

缓存类型

22.1.6 报文样例

请求方法

 
POST /portalapi/ getRewardsInfo

请求报文

 
<Request>
    <msisdn>12</msisdn>
</Request>
 

响应报文

 
<Request>
<msisdn>15600000000</msisdn>
<bookId>798326686</bookId>
<rewardMount>10.17</rewardMount>
<recordId>12</recordId>
<recordTime>20150609182823</recordTime>
<dateTime>20150610112823</dateTime>
</Request>
 

22.1.7 接口响应码

响应码

描述

2000

其他错误

601001

动态记录id为空

601002

没有打赏动态

22.2 getSignInInfoList查询用户签到情况列表

22.2.1 接口描述

查询用户签到情况列表

22.2.2 最后修改信息

22.2.3 调用方

22.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

身份id

beginDate

Request

String

1

开始日期

endDate

Request

String

1

结束日期

响应消息体

字段名

父字段名

字段类型

出现次数

描述

total

Response

String

1

签到总次数

signInInfoList

Response

List

0..1

签到信息列表

signInInfo

signInInfoList

List

0..1

签到信息

signInDate

signInInfo

String

1

签到日期

continuousCount

signInInfo

Init

1

连续签到次数

cumulativeCount

signInInfo

Init

1

本月累计签到次数[0,31]

prizeList

signInInfo

List

0..1

奖品列表

prize

prizeList

List

0..n

奖品

signInDate

prize

String

1

签到日期

prizeType

prize

String

1

奖励类型

prize

prize

String

1

奖品

prizeCount

prize

String

1

奖品数量

 

22.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

sns_sign_in_records_**01~12

签到明细表

sns_sign_in_info

签到信息表

sns_sign_in_prize_records_**01~12

奖品记录表

涉及的缓存

缓存名

描述

缓存类型

22.2.6 报文样例

请求方法

 
POST /portalapi/ getRewardsInfo

请求报文

 
<Request>
<msisdn>13871590176</msisdn>
<beginDate>20150801</beginDate>
<endDate>20150824</endDate>
</Request>
 

响应报文

 
<Request>
<total>1</total>
<signInInfoList>
<signInInfo>
    <signInDate>20150813</signInDate>
    <continuousCount>1</continuousCount>
    <cumulativeCount>1</cumulativeCount>
    <prizeList >
      <prize>
        <signInDate>20150813</signInDate>
        <prizeType>抽奖</prizeType>
        <prize>累计奖励抽奖</prize>
        <prizeCount>10</prizeCount>
      </prize>
      <prize>
        <signInDate>20150813</signInDate>
        <prizeType>道具</prizeType>
        <prize>连续奖励礼包道具</prize>
        <prizeCount>3</prizeCount>
      </prize>
      <prize>
        <signInDate>20150813</signInDate>
        <prizeType>道具</prizeType>
        <prize>累计奖励抽奖</prize>
        <prize>累计奖励礼包道具</prize>
      </prize>
      </prizeList>
</signInInfo>
</signInInfoList>
</Request>
 

22.2.7 接口响应码

响应码

描述

2000

其他错误

601001

身份id为空

601002

身份id非法

601003

开始日期为空

601004

开始日期非法

601005

结束日期为空

601006

结束日期非法

601007

查询日期超出范围

23 CMI23

23.1 getDuibaUrl生成免登陆兑吧URL

23.1.1 接口描述

生成免登陆兑吧url接口

23.1.2 最后修改信息

23.1.3 调用方

23.1.4 消息体定义

请求方式

 

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

redirecturl

Request

String

0..1

积分商城内页url

 

响应消息体

字段名

父字段名

字段类型

出现次数

描述

autourl

Response

String

1

免登录url

 

23.1.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

basic_settings

系统参数表

涉及的缓存

缓存名

描述

缓存类型

23.1.6 报文样例

请求方法

POST /portalapi/ getDuibaUrl

请求报文

 
<Request>
<msisdn>18712345678</msisdn>
<redirecturl> http://www.duiba.com.cn/chome/index</redirecturl>
</Request>
 

响应报文

 
<Request>
<autourl>http://www.duiba.com.cn/autoLogin/autologin?uid=18712345678&credits=1000&timestamp=1415250311646&redirect= http://www.duiba.com.cn/chome/index&sign=868a4339ea0400aec9b7a4742e06120e</autourl>
</Request>
 

23.1.7 接口响应码

响应码

描述

10001

阅读号为空

10002

阅读号非法

2000

互动server其它错误

23.2 deductScore用户积分扣除

23.2.1 接口描述

用户积分扣除接口

23.2.2 最后修改信息

23.2.3 调用方

23.2.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

msisdn

Request

String

1

阅读号

description

Request

String

1

本次积分消耗的描述

score

Request

String

1

扣减积分

timestamp

Request

String

0..1

时间戳

orderNum

Request

String

1

兑吧订单号

type

Request

String

1

兑换类型:alipay(支付宝), qb(Q), coupon(优惠券), object(实物), phonebill(话费), phoneFlow(流量), virtual(虚拟商品), turntable(大转盘), singleLottery(单品抽奖) 所有类型不区分大小写

facePrice

Request

String

0..1

兑换商品的市场价值

(单位:分)

actualPrice

Request

String

1

实际扣除开发者费用(单位:分)

 

响应消息体

字段名

父字段名

字段类型

出现次数

描述

status

Response

String

1

扣积分结果

message

Response

String

1

操作结果

errorMessage

Response

String

0..1

错误信息;成功不返回

bizId

Response

String

0..1

互动创建的订单号;失败不返回

credits

Response

String

1

用户积分余额

 

23.2.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

USER_SCORE_ORDER

兑吧订单记录表

涉及的缓存

缓存名

描述

缓存类型

23.2.6 报文样例

请求方法

POST /portalapi/ deductScore

请求报文

 
<Request>
<msisdn>18712345678</msisdn>
<description>兑换物品扣除积分16000</description>
<score> 100</score>
<timestamp> 1415250311646 </timestamp>
<ordernum> ordernum20150820141215060001</ordernum>
<type>qb</type >
<facePrice>16000</facePrice>
<actualPrice>16000</actualPrice>
</Request>

响应报文

<Response>
<status>200</status>
<message>操作成功</message>
<bizId>13001234567_ordernum20150820141215060001</bizId>
<credits>100</credits>
</Response>
 
<Response>
<status>9001</status>
<message>操作失败</message>
<errorMessage>服务器异常,请稍后再试</errorMessage>
<credits>100</credits>
</Response>
 

23.2.7 接口响应码

status字段值

描述

200

扣减成功

10001

阅读号为空

10002

阅读号非法,不是11

70002

扣减积分大于用户积分余额

70003

扣减积分为空或非数字

70004

facePrize非数字

70005

actualPrize为空或非数字

70006

type为空

70007

description为空

70008

orderNum为空

2000(直接返回响应码,无报文)

互动server其它错误

23.3 exchangeResultNotify订单兑换结果通知接口

23.3.1 接口描述

订单兑换结果通知接口

23.3.2 最后修改信息

23.3.3 调用方

23.3.4 消息体定义

请求方式

POST

请求消息体

字段名

父字段名

字段类型

出现次数

描述

bizId

Request

String

0..1

互动保存的订单流水号

兑吧有返回bizId时,需要SMU接口机返回

timestamp

Request

String

1

1970-01-01开始的时间戳,毫秒。

success

Request

String

1

兑换是否成功

0:  1:

orderNum

Request

String

1

兑吧订单号


响应消息体

字段名

父字段名

字段类型

出现次数

描述

resultCode

Response

String

1

处理结果

200: 成功

SMU接口机收到200后,返回OK给兑吧

 

23.3.5 涉及的数据源(tableoscachememcache

涉及的表

表名

描述

USER_SCORE_ORDER

兑吧订单记录表

涉及的缓存

缓存名

描述

缓存类型

23.3.6 报文样例

请求方法

POST /portalapi/ exchangeResultNotify

请求报文

请求报文

 
<Request>
<bizId>1001</bizId>
<timestamp> 1415250311646 </timestamp>
<success>1</success>
<rderNum>order_cmread_201508250100</orderNum>
</Request>
 

响应报文

 
<Response>
<resultCode>200</resultCode>
</Response>
 

23.3.7 接口响应码

响应码

描述

200

成果,SMU接口机收到200后,返回OK给兑吧

70011

重复通知,SMU接口机收到70011后,返回OK给兑吧

70012

orderNum为空

70013

订单不存在

70014

success为空或非法(0:失败 1:成功)

2000

互动server其它错误

24错误码表

错误码表请参考ResultCode.java,请从如下地址下载 https://szxsvn01-in:3690/svn/AS_SID_SVN/iRead_src/branches/sns/CMI07/snsserver/src/com/huawei/iread/snsserver/constant/ResultCode.java